From 0157f0b2e2d6f4cc2515f062e48e0caba993ad30 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Thu, 28 Feb 2019 17:22:42 +0100 Subject: [PATCH] Cleanup old docs/ (now on gh-pages branch) (#747) --- docs/404.html | 17 - docs/CONTRIBUTING.html | 26 - docs/METHODS_EVENTS.html | 29 - docs/METHODS_EXTRINSICS.html | 29 - docs/METHODS_RPC.html | 29 - docs/METHODS_STORAGE.html | 29 - docs/SUMMARY.html | 21 - docs/SUMMARY.md | 193 -- docs/api-derive/README.md | 11 - docs/api-derive/SUMMARY.html | 21 - docs/api-derive/SUMMARY.md | 28 - ...eferenduminfo_.referenduminfoextended.html | 21 - ..._referenduminfo_.referenduminfoextended.md | 512 ---- docs/api-derive/index.html | 21 - .../modules/_accounts_idandindex_.html | 21 - .../modules/_accounts_idandindex_.md | 34 - .../modules/_accounts_idtoindex_.html | 21 - .../modules/_accounts_idtoindex_.md | 22 - .../modules/_accounts_indexes_.html | 21 - docs/api-derive/modules/_accounts_indexes_.md | 38 - .../modules/_accounts_indextoid_.html | 21 - .../modules/_accounts_indextoid_.md | 22 - docs/api-derive/modules/_balances_fees_.html | 21 - docs/api-derive/modules/_balances_fees_.md | 22 - .../modules/_balances_validatingbalance_.html | 21 - .../modules/_balances_validatingbalance_.md | 22 - .../_balances_validatingbalances_.html | 21 - .../modules/_balances_validatingbalances_.md | 22 - .../modules/_balances_votingbalance_.html | 21 - .../modules/_balances_votingbalance_.md | 22 - .../modules/_balances_votingbalances_.html | 21 - .../modules/_balances_votingbalances_.md | 22 - ...balances_votingbalancesnominatorsfor_.html | 21 - .../_balances_votingbalancesnominatorsfor_.md | 22 - .../modules/_chain_bestnumber_.html | 24 - docs/api-derive/modules/_chain_bestnumber_.md | 32 - .../modules/_chain_bestnumberfinalised_.html | 24 - .../modules/_chain_bestnumberfinalised_.md | 30 - .../modules/_chain_bestnumberlag_.html | 24 - .../modules/_chain_bestnumberlag_.md | 32 - .../api-derive/modules/_chain_getheader_.html | 24 - docs/api-derive/modules/_chain_getheader_.md | 32 - .../modules/_chain_subscribenewhead_.html | 24 - .../modules/_chain_subscribenewhead_.md | 44 - .../modules/_democracy_referenduminfo_.html | 21 - .../modules/_democracy_referenduminfo_.md | 34 - .../modules/_democracy_referenduminfos_.html | 21 - .../modules/_democracy_referenduminfos_.md | 22 - .../modules/_democracy_referendums_.html | 21 - .../modules/_democracy_referendums_.md | 22 - .../_democracy_referendumvotesfor_.html | 21 - .../modules/_democracy_referendumvotesfor_.md | 22 - .../api-derive/modules/_democracy_votes_.html | 21 - docs/api-derive/modules/_democracy_votes_.md | 22 - .../modules/_session_eralength_.html | 21 - .../api-derive/modules/_session_eralength_.md | 22 - .../modules/_session_eraprogress_.html | 21 - .../modules/_session_eraprogress_.md | 22 - .../modules/_session_sessionprogress_.html | 21 - .../modules/_session_sessionprogress_.md | 22 - .../modules/_staking_intentionsbalances_.html | 21 - .../modules/_staking_intentionsbalances_.md | 24 - docs/api-derive/modules/_types_.html | 21 - docs/api-derive/modules/_types_.md | 51 - docs/api-derive/modules/_util_cache_.html | 21 - docs/api-derive/modules/_util_cache_.md | 25 - docs/api-derive/modules/_util_drr_.html | 21 - docs/api-derive/modules/_util_drr_.md | 2 - docs/api/README.md | 107 - docs/api/SUMMARY.html | 21 - docs/api/SUMMARY.md | 35 - docs/api/classes/_base_.apibase.html | 56 - docs/api/classes/_base_.apibase.md | 345 --- .../api/classes/_promise_api_.apipromise.html | 122 - docs/api/classes/_promise_api_.apipromise.md | 551 ----- .../_promise_combinator_.combinator.html | 21 - .../_promise_combinator_.combinator.md | 41 - docs/api/classes/_rx_api_.apirx.html | 134 -- docs/api/classes/_rx_api_.apirx.md | 551 ----- ...ttableextrinsic_.submittableextrinsic.html | 21 - ...mittableextrinsic_.submittableextrinsic.md | 699 ------ ...bmittableextrinsic_.submittableresult.html | 21 - ...submittableextrinsic_.submittableresult.md | 473 ---- docs/api/index.html | 67 - .../_promise_types_.apipromiseinterface.html | 56 - .../_promise_types_.apipromiseinterface.md | 384 --- .../interfaces/_rx_types_.apirxinterface.html | 56 - .../interfaces/_rx_types_.apirxinterface.md | 393 ---- .../interfaces/_types_.apibaseinterface.html | 21 - .../interfaces/_types_.apibaseinterface.md | 73 - .../_types_.apiinterface_decorated.html | 21 - .../_types_.apiinterface_decorated.md | 93 - docs/api/interfaces/_types_.apioptions.html | 21 - docs/api/interfaces/_types_.apioptions.md | 64 - docs/api/interfaces/_types_.decoratedrpc.html | 21 - docs/api/interfaces/_types_.decoratedrpc.md | 48 - .../_types_.decoratedrpc_method.html | 21 - .../interfaces/_types_.decoratedrpc_method.md | 49 - .../_types_.decoratedrpc_section.html | 21 - .../_types_.decoratedrpc_section.md | 12 - docs/api/interfaces/_types_.derive.html | 21 - docs/api/interfaces/_types_.derive.md | 12 - .../interfaces/_types_.derivemethodbase.html | 21 - .../interfaces/_types_.derivemethodbase.md | 22 - .../api/interfaces/_types_.derivesection.html | 21 - docs/api/interfaces/_types_.derivesection.md | 12 - .../_types_.queryablemodulestorage.html | 21 - .../_types_.queryablemodulestorage.md | 12 - .../interfaces/_types_.queryablestorage.html | 21 - .../interfaces/_types_.queryablestorage.md | 12 - .../_types_.queryablestoragefunctionbase.html | 21 - .../_types_.queryablestoragefunctionbase.md | 169 -- docs/api/interfaces/_types_.signer.html | 21 - docs/api/interfaces/_types_.signer.md | 44 - .../_types_.submittableextrinsicfunction.html | 21 - .../_types_.submittableextrinsicfunction.md | 99 - .../_types_.submittableextrinsics.html | 21 - .../_types_.submittableextrinsics.md | 12 - .../_types_.submittablemoduleextrinsics.html | 21 - .../_types_.submittablemoduleextrinsics.md | 12 - docs/api/modules/_base_.html | 21 - docs/api/modules/_base_.md | 10 - docs/api/modules/_checktypes_manual_.html | 21 - docs/api/modules/_checktypes_manual_.md | 16 - docs/api/modules/_promise_api_.html | 21 - docs/api/modules/_promise_api_.md | 10 - docs/api/modules/_promise_combinator_.html | 21 - docs/api/modules/_promise_combinator_.md | 58 - docs/api/modules/_promise_types_.html | 21 - docs/api/modules/_promise_types_.md | 66 - docs/api/modules/_rx_api_.html | 21 - docs/api/modules/_rx_api_.md | 10 - docs/api/modules/_rx_types_.html | 21 - docs/api/modules/_rx_types_.md | 26 - docs/api/modules/_submittableextrinsic_.html | 21 - docs/api/modules/_submittableextrinsic_.md | 11 - docs/api/modules/_types_.html | 21 - docs/api/modules/_types_.md | 146 -- docs/api/modules/_util_filterevents_.html | 21 - docs/api/modules/_util_filterevents_.md | 24 - docs/api/modules/_util_logging_.html | 21 - docs/api/modules/_util_logging_.md | 2 - docs/assets/css/0.styles.22f13802.css | 1 - docs/assets/img/search.83621669.svg | 1 - docs/assets/js/10.730dd1f8.js | 1 - docs/assets/js/100.ca511823.js | 1 - docs/assets/js/101.553ffa55.js | 1 - docs/assets/js/102.0da1ec79.js | 1 - docs/assets/js/103.1f02833f.js | 1 - docs/assets/js/104.85ac0811.js | 1 - docs/assets/js/105.7e80c03b.js | 1 - docs/assets/js/106.5e6f31b1.js | 1 - docs/assets/js/107.5f08e115.js | 1 - docs/assets/js/108.643f37cd.js | 1 - docs/assets/js/109.2bfc3f88.js | 1 - docs/assets/js/11.16564673.js | 1 - docs/assets/js/110.391cd976.js | 1 - docs/assets/js/111.247898ab.js | 1 - docs/assets/js/112.1979bc80.js | 1 - docs/assets/js/113.4097126a.js | 1 - docs/assets/js/114.7c298e55.js | 1 - docs/assets/js/115.0568f994.js | 1 - docs/assets/js/116.7c28a393.js | 1 - docs/assets/js/117.bf1a2cc6.js | 1 - docs/assets/js/118.b1c65641.js | 1 - docs/assets/js/119.21ea0a94.js | 1 - docs/assets/js/12.23b26fea.js | 1 - docs/assets/js/120.32f79155.js | 1 - docs/assets/js/121.84147bfd.js | 1 - docs/assets/js/122.9d807a94.js | 1 - docs/assets/js/123.2a822b35.js | 1 - docs/assets/js/124.4e7f4672.js | 1 - docs/assets/js/125.2e967439.js | 1 - docs/assets/js/126.2f75633a.js | 1 - docs/assets/js/127.6a1e1746.js | 1 - docs/assets/js/128.7cff7178.js | 1 - docs/assets/js/129.ea33f5cb.js | 1 - docs/assets/js/13.89e4dbaf.js | 1 - docs/assets/js/130.3c5e03a1.js | 1 - docs/assets/js/131.dcf81ac8.js | 1 - docs/assets/js/132.cfdf6b8f.js | 1 - docs/assets/js/133.1a7accd7.js | 1 - docs/assets/js/134.402b574e.js | 1 - docs/assets/js/135.7dd6b4db.js | 1 - docs/assets/js/136.9dcd2366.js | 1 - docs/assets/js/137.cdee1656.js | 1 - docs/assets/js/138.39184086.js | 1 - docs/assets/js/139.f90df65f.js | 1 - docs/assets/js/14.8212f44f.js | 1 - docs/assets/js/140.df0fdbee.js | 1 - docs/assets/js/141.3ac35658.js | 1 - docs/assets/js/142.b2cceeea.js | 1 - docs/assets/js/143.580c8451.js | 1 - docs/assets/js/144.68e753bb.js | 1 - docs/assets/js/145.340cc950.js | 1 - docs/assets/js/146.cf86a887.js | 1 - docs/assets/js/147.e8467d58.js | 1 - docs/assets/js/148.d62977b0.js | 1 - docs/assets/js/149.4423ac17.js | 1 - docs/assets/js/15.d8a6af32.js | 1 - docs/assets/js/150.27c79c1e.js | 1 - docs/assets/js/151.f45a01cd.js | 1 - docs/assets/js/152.9e0ddfd2.js | 1 - docs/assets/js/153.dd79521c.js | 1 - docs/assets/js/154.d684ed56.js | 1 - docs/assets/js/155.132e736b.js | 1 - docs/assets/js/156.7375610d.js | 1 - docs/assets/js/157.3015cd77.js | 1 - docs/assets/js/158.3fdd4c6d.js | 1 - docs/assets/js/159.3879d14f.js | 1 - docs/assets/js/16.40151e05.js | 1 - docs/assets/js/160.2187440a.js | 1 - docs/assets/js/161.680a3a2c.js | 1 - docs/assets/js/162.0715e720.js | 1 - docs/assets/js/163.13f3ff17.js | 1 - docs/assets/js/164.729efdb3.js | 1 - docs/assets/js/165.d4599569.js | 1 - docs/assets/js/166.1d7b1fd8.js | 1 - docs/assets/js/167.67c476d6.js | 1 - docs/assets/js/168.1a2681d6.js | 1 - docs/assets/js/169.6f182405.js | 1 - docs/assets/js/17.0cadbbe1.js | 1 - docs/assets/js/170.e5a9cf81.js | 1 - docs/assets/js/171.0fa7c9d5.js | 1 - docs/assets/js/172.ea468e02.js | 1 - docs/assets/js/173.0b544598.js | 1 - docs/assets/js/174.9ab8554e.js | 1 - docs/assets/js/175.9c2273db.js | 1 - docs/assets/js/176.c8ca0f49.js | 1 - docs/assets/js/177.5fa49e5c.js | 1 - docs/assets/js/178.85753470.js | 1 - docs/assets/js/179.33c19c3b.js | 1 - docs/assets/js/18.714d6145.js | 1 - docs/assets/js/180.f41fbd45.js | 1 - docs/assets/js/181.3cbec004.js | 1 - docs/assets/js/182.be73a590.js | 1 - docs/assets/js/183.97ea8694.js | 1 - docs/assets/js/184.f5c4d39a.js | 1 - docs/assets/js/185.63a044a8.js | 1 - docs/assets/js/186.edf6b277.js | 1 - docs/assets/js/187.5c94433e.js | 1 - docs/assets/js/188.7c0aa44e.js | 1 - docs/assets/js/189.21bc2a5f.js | 1 - docs/assets/js/19.ea56dec0.js | 1 - docs/assets/js/190.58531b65.js | 1 - docs/assets/js/191.1c94ebe3.js | 1 - docs/assets/js/192.91f2c9a1.js | 1 - docs/assets/js/193.917b4055.js | 1 - docs/assets/js/194.ae691468.js | 1 - docs/assets/js/195.a6b48df0.js | 1 - docs/assets/js/196.87f89edc.js | 1 - docs/assets/js/197.c36f7ea4.js | 1 - docs/assets/js/198.525a4b7d.js | 1 - docs/assets/js/199.5015f2d3.js | 1 - docs/assets/js/2.16c7e4af.js | 1 - docs/assets/js/20.0e054b48.js | 1 - docs/assets/js/200.75faeee9.js | 1 - docs/assets/js/201.44b6271a.js | 1 - docs/assets/js/202.dfcfe327.js | 1 - docs/assets/js/203.398e2047.js | 1 - docs/assets/js/204.d9b4f519.js | 1 - docs/assets/js/205.2657056f.js | 1 - docs/assets/js/206.e65453db.js | 1 - docs/assets/js/207.4de69828.js | 1 - docs/assets/js/208.984d51cb.js | 1 - docs/assets/js/209.643919d7.js | 1 - docs/assets/js/21.60f7dc48.js | 1 - docs/assets/js/210.b211216d.js | 1 - docs/assets/js/211.1efecaad.js | 1 - docs/assets/js/212.5126bb85.js | 1 - docs/assets/js/213.cf3debe0.js | 1 - docs/assets/js/214.a852db4b.js | 1 - docs/assets/js/215.958e2264.js | 1 - docs/assets/js/216.96259efd.js | 1 - docs/assets/js/217.814d497f.js | 1 - docs/assets/js/218.2b543c38.js | 1 - docs/assets/js/219.cac05f6f.js | 1 - docs/assets/js/22.a7728bb5.js | 1 - docs/assets/js/220.ba0f1b57.js | 1 - docs/assets/js/221.69960261.js | 1 - docs/assets/js/222.16028c06.js | 1 - docs/assets/js/223.e16c683c.js | 1 - docs/assets/js/224.c038df2b.js | 1 - docs/assets/js/225.7df2d9f2.js | 1 - docs/assets/js/226.4c36f1be.js | 1 - docs/assets/js/227.9a2401b9.js | 1 - docs/assets/js/228.1b9fb659.js | 1 - docs/assets/js/229.1e4a771a.js | 1 - docs/assets/js/23.b30fdfff.js | 1 - docs/assets/js/230.73c4c7fc.js | 1 - docs/assets/js/231.e7c0d9a5.js | 1 - docs/assets/js/232.5648aca5.js | 1 - docs/assets/js/233.b647f4f0.js | 1 - docs/assets/js/234.868104fc.js | 1 - docs/assets/js/235.ecd00231.js | 1 - docs/assets/js/236.ac517b92.js | 1 - docs/assets/js/237.06cb3f91.js | 1 - docs/assets/js/238.6cb64904.js | 1 - docs/assets/js/239.63a6f16d.js | 1 - docs/assets/js/24.0868fa0c.js | 1 - docs/assets/js/240.c384fb29.js | 1 - docs/assets/js/241.cf9360a5.js | 1 - docs/assets/js/242.8ddb5516.js | 1 - docs/assets/js/243.9ef77bc3.js | 1 - docs/assets/js/244.0ccec493.js | 1 - docs/assets/js/245.d2970f61.js | 1 - docs/assets/js/246.964b56ca.js | 1 - docs/assets/js/247.fe054aa5.js | 1 - docs/assets/js/248.3616d6f4.js | 1 - docs/assets/js/249.4b683772.js | 1 - docs/assets/js/25.c9768e23.js | 1 - docs/assets/js/250.73e40a70.js | 1 - docs/assets/js/251.7558f2ea.js | 1 - docs/assets/js/252.15f2dfec.js | 1 - docs/assets/js/253.95cd7122.js | 1 - docs/assets/js/254.b0b505a9.js | 1 - docs/assets/js/255.cbeb6d0d.js | 1 - docs/assets/js/256.aebda57b.js | 1 - docs/assets/js/257.6c8ec712.js | 1 - docs/assets/js/258.87f76ceb.js | 1 - docs/assets/js/259.2e0368b6.js | 1 - docs/assets/js/26.7808132a.js | 1 - docs/assets/js/260.2248090b.js | 1 - docs/assets/js/261.08c9df99.js | 1 - docs/assets/js/262.3ff926a4.js | 1 - docs/assets/js/263.45570ce9.js | 1 - docs/assets/js/264.41f7177f.js | 1 - docs/assets/js/265.a1c048fa.js | 1 - docs/assets/js/266.3c3e4de7.js | 1 - docs/assets/js/267.3098152d.js | 1 - docs/assets/js/268.6741a34e.js | 1 - docs/assets/js/269.1fd28d56.js | 1 - docs/assets/js/27.fe4b5c14.js | 1 - docs/assets/js/270.dcc22e3a.js | 1 - docs/assets/js/271.3e4a008a.js | 1 - docs/assets/js/272.8d20003e.js | 1 - docs/assets/js/273.d3ba5b3e.js | 1 - docs/assets/js/274.5faf4627.js | 1 - docs/assets/js/275.6ce9fcd9.js | 1 - docs/assets/js/276.086d7309.js | 1 - docs/assets/js/277.136cb807.js | 1 - docs/assets/js/278.9218f102.js | 1 - docs/assets/js/279.293915b9.js | 1 - docs/assets/js/28.83f8aa65.js | 1 - docs/assets/js/280.7f0bf3fd.js | 1 - docs/assets/js/281.e4381f47.js | 1 - docs/assets/js/282.607fde22.js | 1 - docs/assets/js/283.ac798380.js | 1 - docs/assets/js/284.007fd642.js | 1 - docs/assets/js/285.b84294e3.js | 1 - docs/assets/js/286.c64351b3.js | 1 - docs/assets/js/287.d27f6e11.js | 1 - docs/assets/js/288.ac370bde.js | 1 - docs/assets/js/289.e7d1422e.js | 1 - docs/assets/js/29.47b5be8d.js | 1 - docs/assets/js/290.0a031606.js | 1 - docs/assets/js/291.8de8ff06.js | 1 - docs/assets/js/292.bb0ea38c.js | 1 - docs/assets/js/293.52eda1cd.js | 1 - docs/assets/js/294.2cacd6cf.js | 1 - docs/assets/js/295.7fe48d44.js | 1 - docs/assets/js/296.f61c2c00.js | 1 - docs/assets/js/297.c1127367.js | 1 - docs/assets/js/298.b924b2b9.js | 1 - docs/assets/js/299.932c15ac.js | 1 - docs/assets/js/3.04cf2d04.js | 1 - docs/assets/js/30.a8182388.js | 1 - docs/assets/js/300.d570b029.js | 1 - docs/assets/js/301.019d11c7.js | 1 - docs/assets/js/302.c611b601.js | 1 - docs/assets/js/303.a376d327.js | 1 - docs/assets/js/304.5f0cff90.js | 1 - docs/assets/js/305.63e74ee3.js | 1 - docs/assets/js/306.cca22ee6.js | 1 - docs/assets/js/307.c95b53d7.js | 1 - docs/assets/js/308.5fda621d.js | 1 - docs/assets/js/309.9b876058.js | 1 - docs/assets/js/31.f46c7404.js | 1 - docs/assets/js/310.419a700f.js | 1 - docs/assets/js/311.f8af589d.js | 1 - docs/assets/js/312.2450b227.js | 1 - docs/assets/js/313.b9009865.js | 1 - docs/assets/js/314.53a72f42.js | 1 - docs/assets/js/315.984b43a5.js | 1 - docs/assets/js/316.0c709a9e.js | 1 - docs/assets/js/317.60e8df6c.js | 1 - docs/assets/js/318.c630d384.js | 1 - docs/assets/js/319.b2671ca4.js | 1 - docs/assets/js/32.d1cfa31f.js | 1 - docs/assets/js/320.afbbd029.js | 1 - docs/assets/js/321.339d71c2.js | 1 - docs/assets/js/322.e9f5bb56.js | 1 - docs/assets/js/323.18234317.js | 1 - docs/assets/js/324.876d6fa4.js | 1 - docs/assets/js/325.760b9745.js | 1 - docs/assets/js/326.6d4fa02d.js | 1 - docs/assets/js/327.281fe456.js | 1 - docs/assets/js/328.c5495c85.js | 1 - docs/assets/js/329.ed360faa.js | 1 - docs/assets/js/33.8a0e0669.js | 1 - docs/assets/js/330.f19292df.js | 1 - docs/assets/js/331.4c61687a.js | 1 - docs/assets/js/332.a3d97398.js | 1 - docs/assets/js/333.59e4acd9.js | 1 - docs/assets/js/334.50b4fc9a.js | 1 - docs/assets/js/335.8601cab4.js | 1 - docs/assets/js/336.e5fe146e.js | 1 - docs/assets/js/337.34dc215b.js | 1 - docs/assets/js/338.e2dbfeee.js | 1 - docs/assets/js/339.86dcca2a.js | 1 - docs/assets/js/34.b504662f.js | 1 - docs/assets/js/340.fb493bcb.js | 1 - docs/assets/js/341.7793a420.js | 1 - docs/assets/js/342.894cba5f.js | 1 - docs/assets/js/343.808d0d4b.js | 1 - docs/assets/js/344.c80cd4fa.js | 1 - docs/assets/js/345.7c227d05.js | 1 - docs/assets/js/346.b1f040e3.js | 1 - docs/assets/js/347.b45f5f70.js | 1 - docs/assets/js/348.111d9030.js | 1 - docs/assets/js/349.beab680d.js | 1 - docs/assets/js/35.7026463c.js | 1 - docs/assets/js/350.dd8e26c9.js | 1 - docs/assets/js/351.d5d29456.js | 1 - docs/assets/js/352.4ca1680f.js | 1 - docs/assets/js/353.a00d14f4.js | 1 - docs/assets/js/354.f8abebf6.js | 1 - docs/assets/js/355.7bf4ffd3.js | 1 - docs/assets/js/356.8c59d551.js | 1 - docs/assets/js/357.8b269634.js | 1 - docs/assets/js/358.0d9fae89.js | 1 - docs/assets/js/359.1864fd51.js | 1 - docs/assets/js/36.83308d7e.js | 1 - docs/assets/js/360.995c1f87.js | 1 - docs/assets/js/361.07f86df7.js | 1 - docs/assets/js/362.2377269e.js | 1 - docs/assets/js/363.a7e04d3f.js | 1 - docs/assets/js/364.3a087e99.js | 1 - docs/assets/js/365.7e7081ca.js | 1 - docs/assets/js/366.d6ed06a5.js | 1 - docs/assets/js/367.1ed3b875.js | 1 - docs/assets/js/368.2726ec3d.js | 1 - docs/assets/js/369.be7a251d.js | 1 - docs/assets/js/37.1b12964f.js | 1 - docs/assets/js/370.d728c50e.js | 1 - docs/assets/js/371.1221fd08.js | 1 - docs/assets/js/372.ed7d2826.js | 1 - docs/assets/js/373.3a75111b.js | 1 - docs/assets/js/374.e62cbb4c.js | 1 - docs/assets/js/375.91881f5b.js | 1 - docs/assets/js/376.1db690d5.js | 1 - docs/assets/js/377.de5d9945.js | 1 - docs/assets/js/378.66e8da8f.js | 1 - docs/assets/js/379.a33060cc.js | 1 - docs/assets/js/38.6e2028aa.js | 1 - docs/assets/js/380.b99b07cb.js | 1 - docs/assets/js/381.ecdccf3b.js | 1 - docs/assets/js/382.74ce6934.js | 1 - docs/assets/js/383.b2df99e3.js | 1 - docs/assets/js/384.3340f275.js | 1 - docs/assets/js/385.d812add9.js | 1 - docs/assets/js/386.88818459.js | 1 - docs/assets/js/387.6ca2ea8e.js | 1 - docs/assets/js/388.2a85b4d3.js | 1 - docs/assets/js/389.32e60d49.js | 1 - docs/assets/js/39.2ef37369.js | 1 - docs/assets/js/390.bf318495.js | 1 - docs/assets/js/391.93d6b009.js | 1 - docs/assets/js/392.5b3ed9eb.js | 1 - docs/assets/js/393.129cca6c.js | 1 - docs/assets/js/394.e51c5ace.js | 1 - docs/assets/js/395.f2f04b18.js | 1 - docs/assets/js/396.1fd42ede.js | 1 - docs/assets/js/397.c1813965.js | 1 - docs/assets/js/398.32eb13aa.js | 1 - docs/assets/js/399.795446a3.js | 1 - docs/assets/js/4.adbf2d29.js | 1 - docs/assets/js/40.49c833ce.js | 1 - docs/assets/js/400.f6ece95d.js | 1 - docs/assets/js/401.0002d8cf.js | 1 - docs/assets/js/402.dd239bd6.js | 1 - docs/assets/js/403.162a25a1.js | 1 - docs/assets/js/404.cd26d08b.js | 1 - docs/assets/js/405.41d2d800.js | 1 - docs/assets/js/406.b4c405ad.js | 1 - docs/assets/js/407.1482cae8.js | 1 - docs/assets/js/408.b826a189.js | 1 - docs/assets/js/409.be518933.js | 1 - docs/assets/js/41.0e6ea377.js | 1 - docs/assets/js/410.86fff13b.js | 1 - docs/assets/js/411.6c670c0f.js | 1 - docs/assets/js/412.8092ef28.js | 1 - docs/assets/js/413.19be8b54.js | 1 - docs/assets/js/414.76493004.js | 1 - docs/assets/js/415.bdff2d2d.js | 1 - docs/assets/js/416.889eb219.js | 1 - docs/assets/js/417.534b13ab.js | 1 - docs/assets/js/418.d43b51b8.js | 1 - docs/assets/js/419.e38eec68.js | 1 - docs/assets/js/42.8407b7c4.js | 1 - docs/assets/js/420.bf13b289.js | 1 - docs/assets/js/421.616046f6.js | 1 - docs/assets/js/422.3933effc.js | 1 - docs/assets/js/423.21e1d41f.js | 1 - docs/assets/js/424.c7c086b6.js | 1 - docs/assets/js/425.54913cd2.js | 1 - docs/assets/js/426.a7fed113.js | 1 - docs/assets/js/427.7f371c22.js | 1 - docs/assets/js/428.08745b54.js | 1 - docs/assets/js/429.d20bd9c7.js | 1 - docs/assets/js/43.5f2da7c0.js | 1 - docs/assets/js/430.f2cbef53.js | 1 - docs/assets/js/431.42063ff2.js | 1 - docs/assets/js/432.b47603bf.js | 1 - docs/assets/js/433.4f152866.js | 1 - docs/assets/js/434.cd85ac32.js | 1 - docs/assets/js/435.55e8c3a4.js | 1 - docs/assets/js/436.b77a1376.js | 1 - docs/assets/js/437.69537313.js | 1 - docs/assets/js/438.6258626a.js | 1 - docs/assets/js/439.233d0a88.js | 1 - docs/assets/js/44.8aeba118.js | 1 - docs/assets/js/440.ddb31beb.js | 1 - docs/assets/js/441.4822f02c.js | 1 - docs/assets/js/442.b941fe1e.js | 1 - docs/assets/js/443.4cf74cfd.js | 1 - docs/assets/js/444.c39a1007.js | 1 - docs/assets/js/445.03050f12.js | 1 - docs/assets/js/446.889f7a8c.js | 1 - docs/assets/js/447.2ec94099.js | 1 - docs/assets/js/448.162c943f.js | 1 - docs/assets/js/449.9d0db40b.js | 1 - docs/assets/js/45.c2214929.js | 1 - docs/assets/js/450.5083ce7e.js | 1 - docs/assets/js/451.11fca1f7.js | 1 - docs/assets/js/452.5d4a004c.js | 1 - docs/assets/js/453.a8206442.js | 1 - docs/assets/js/454.3040d79f.js | 1 - docs/assets/js/455.e3040085.js | 1 - docs/assets/js/456.4e7ac5cc.js | 1 - docs/assets/js/457.99bd9def.js | 1 - docs/assets/js/458.135f5897.js | 1 - docs/assets/js/459.65aeb544.js | 1 - docs/assets/js/46.94e69ce6.js | 1 - docs/assets/js/460.46c9c6c5.js | 1 - docs/assets/js/47.f9256cd5.js | 1 - docs/assets/js/48.38486aa1.js | 1 - docs/assets/js/49.9d343381.js | 1 - docs/assets/js/5.45a9bb87.js | 1 - docs/assets/js/50.5fe10ce8.js | 1 - docs/assets/js/51.02b977ea.js | 1 - docs/assets/js/52.55f294e3.js | 1 - docs/assets/js/53.49b9b3f7.js | 1 - docs/assets/js/54.4b6f6495.js | 1 - docs/assets/js/55.0768babe.js | 1 - docs/assets/js/56.a6db3bce.js | 1 - docs/assets/js/57.8437eb37.js | 1 - docs/assets/js/58.fa6e99dd.js | 1 - docs/assets/js/59.09d0c438.js | 1 - docs/assets/js/6.faddde38.js | 1 - docs/assets/js/60.873c4917.js | 1 - docs/assets/js/61.18b20d40.js | 1 - docs/assets/js/62.5e5f1d72.js | 1 - docs/assets/js/63.2de916c2.js | 1 - docs/assets/js/64.afd165df.js | 1 - docs/assets/js/65.ee2bfa33.js | 1 - docs/assets/js/66.9c6a9f66.js | 1 - docs/assets/js/67.ff49dc36.js | 1 - docs/assets/js/68.1de2396b.js | 1 - docs/assets/js/69.9e892d0b.js | 1 - docs/assets/js/7.7d20a020.js | 1 - docs/assets/js/70.0fa5cf88.js | 1 - docs/assets/js/71.906dbe9f.js | 1 - docs/assets/js/72.77fd6d42.js | 1 - docs/assets/js/73.efcf09f8.js | 1 - docs/assets/js/74.22a477fd.js | 1 - docs/assets/js/75.9e613539.js | 1 - docs/assets/js/76.fc057215.js | 1 - docs/assets/js/77.d2c78482.js | 1 - docs/assets/js/78.51114efa.js | 1 - docs/assets/js/79.d40e5274.js | 1 - docs/assets/js/8.91aa366b.js | 1 - docs/assets/js/80.947f0d3e.js | 1 - docs/assets/js/81.e243d073.js | 1 - docs/assets/js/82.95e1e9ef.js | 1 - docs/assets/js/83.78169173.js | 1 - docs/assets/js/84.4a6dfa97.js | 1 - docs/assets/js/85.531e272e.js | 1 - docs/assets/js/86.b95e8133.js | 1 - docs/assets/js/87.d8fdeb9d.js | 1 - docs/assets/js/88.18d0ae4f.js | 1 - docs/assets/js/89.0611fea1.js | 1 - docs/assets/js/9.a28c3096.js | 1 - docs/assets/js/90.0eda8f57.js | 1 - docs/assets/js/91.8bbc3dd9.js | 1 - docs/assets/js/92.f2a6b3f4.js | 1 - docs/assets/js/93.d506ddb5.js | 1 - docs/assets/js/94.22bb7e14.js | 1 - docs/assets/js/95.6985ab8e.js | 1 - docs/assets/js/96.2378ec2d.js | 1 - docs/assets/js/97.1402a4d4.js | 1 - docs/assets/js/98.e668802c.js | 1 - docs/assets/js/99.6746c5ca.js | 1 - docs/assets/js/app.ea488efd.js | 8 - .../promise/01_simple_connect/index.html | 47 - .../promise/02_listen_to_blocks/index.html | 48 - .../03_listen_to_balance_change/index.html | 62 - .../promise/04_unsubscribe/index.html | 52 - .../promise/05_read_storage/index.html | 67 - .../promise/06_make_transfer/index.html | 60 - .../promise/08_system_events/index.html | 63 - .../promise/09_transfer_events/index.html | 84 - .../promise/10_upgrade_chain/index.html | 85 - docs/examples/promise/index.html | 22 - docs/examples/rx/01_simple_connect/index.html | 47 - .../rx/02_listen_to_blocks/index.html | 40 - .../rx/03_listen_to_balance_change/index.html | 21 - docs/examples/rx/04_unsubscribe/index.html | 46 - docs/examples/rx/05_read_storage/index.html | 72 - docs/examples/rx/06_make_transfer/index.html | 56 - docs/examples/rx/08_system_events/index.html | 58 - .../examples/rx/09_transfer_events/index.html | 75 - docs/examples/rx/10_upgrade_chain/index.html | 80 - docs/examples/rx/index.html | 22 - docs/index.html | 21 - docs/rpc-core/README.md | 76 - docs/rpc-core/SUMMARY.html | 21 - docs/rpc-core/SUMMARY.md | 3 - docs/rpc-core/index.html | 58 - .../interfaces/_types_.rpcinterface.html | 21 - .../interfaces/_types_.rpcinterface.md | 45 - .../_types_.rpcinterface_method.html | 21 - .../interfaces/_types_.rpcinterface_method.md | 51 - docs/rpc-core/modules/_types_.html | 21 - docs/rpc-core/modules/_types_.md | 31 - docs/rpc-provider/README.md | 51 - docs/rpc-provider/SUMMARY.html | 21 - docs/rpc-provider/SUMMARY.md | 9 - .../classes/_ws_provider_.wsprovider.html | 36 - .../classes/_ws_provider_.wsprovider.md | 224 -- docs/rpc-provider/index.html | 36 - .../interfaces/_types_.providerinterface.html | 21 - .../interfaces/_types_.providerinterface.md | 129 - docs/rpc-provider/modules/_defaults_.html | 21 - docs/rpc-provider/modules/_defaults_.md | 2 - .../rpc-provider/modules/_http_polyfill_.html | 21 - docs/rpc-provider/modules/_http_polyfill_.md | 2 - docs/rpc-provider/modules/_http_types_.html | 21 - docs/rpc-provider/modules/_http_types_.md | 16 - docs/rpc-provider/modules/_mock_types_.html | 21 - docs/rpc-provider/modules/_mock_types_.md | 76 - docs/rpc-provider/modules/_types_.html | 21 - docs/rpc-provider/modules/_types_.md | 122 - docs/rpc-provider/modules/_ws_polyfill_.html | 21 - docs/rpc-provider/modules/_ws_polyfill_.md | 2 - docs/rpc-provider/modules/_ws_provider_.html | 21 - docs/rpc-provider/modules/_ws_provider_.md | 10 - docs/rpc-rx/README.md | 11 - docs/rpc-rx/SUMMARY.html | 21 - docs/rpc-rx/SUMMARY.md | 1 - docs/rpc-rx/index.html | 21 - docs/rpc-rx/modules/_types_.html | 21 - docs/rpc-rx/modules/_types_.md | 58 - docs/type-extrinsics/README.md | 11 - docs/type-extrinsics/SUMMARY.html | 21 - docs/type-extrinsics/SUMMARY.md | 3 - docs/type-extrinsics/index.html | 21 - .../modules/_frommetadata_.html | 21 - .../type-extrinsics/modules/_frommetadata_.md | 24 - docs/type-extrinsics/modules/_static_.html | 21 - docs/type-extrinsics/modules/_static_.md | 2 - .../modules/_utils_createunchecked_.html | 21 - .../modules/_utils_createunchecked_.md | 27 - docs/type-jsonrpc/README.md | 30 - docs/type-jsonrpc/SUMMARY.html | 21 - docs/type-jsonrpc/SUMMARY.md | 7 - docs/type-jsonrpc/index.html | 22 - docs/type-jsonrpc/modules/_author_.html | 21 - docs/type-jsonrpc/modules/_author_.md | 2 - docs/type-jsonrpc/modules/_chain_.html | 21 - docs/type-jsonrpc/modules/_chain_.md | 2 - .../type-jsonrpc/modules/_create_method_.html | 21 - docs/type-jsonrpc/modules/_create_method_.md | 24 - docs/type-jsonrpc/modules/_create_param_.html | 21 - docs/type-jsonrpc/modules/_create_param_.md | 24 - docs/type-jsonrpc/modules/_state_.html | 21 - docs/type-jsonrpc/modules/_state_.md | 2 - docs/type-jsonrpc/modules/_system_.html | 21 - docs/type-jsonrpc/modules/_system_.md | 2 - docs/type-jsonrpc/modules/_types_.html | 21 - docs/type-jsonrpc/modules/_types_.md | 49 - docs/type-storage/README.md | 11 - docs/type-storage/SUMMARY.html | 21 - docs/type-storage/SUMMARY.md | 9 - docs/type-storage/index.html | 21 - .../interfaces/_types_.modulestorage.html | 21 - .../interfaces/_types_.modulestorage.md | 9 - .../interfaces/_types_.storage.html | 21 - .../interfaces/_types_.storage.md | 23 - ...ils_createfunction_.createitemoptions.html | 21 - ...utils_createfunction_.createitemoptions.md | 27 - docs/type-storage/modules/_frommetadata_.html | 21 - docs/type-storage/modules/_frommetadata_.md | 24 - docs/type-storage/modules/_static_.html | 21 - docs/type-storage/modules/_static_.md | 2 - docs/type-storage/modules/_storage_.html | 21 - docs/type-storage/modules/_storage_.md | 24 - docs/type-storage/modules/_substrate_.html | 39 - docs/type-storage/modules/_substrate_.md | 77 - docs/type-storage/modules/_types_.html | 21 - docs/type-storage/modules/_types_.md | 11 - .../modules/_utils_createfunction_.html | 21 - .../modules/_utils_createfunction_.md | 39 - docs/types/README.md | 31 - docs/types/SUMMARY.html | 21 - docs/types/SUMMARY.md | 315 --- docs/types/classes/_codec_base_.base.html | 21 - docs/types/classes/_codec_base_.base.md | 44 - .../classes/_codec_compact_.compact.html | 21 - docs/types/classes/_codec_compact_.compact.md | 299 --- docs/types/classes/_codec_enum_.enum.html | 21 - docs/types/classes/_codec_enum_.enum.md | 195 -- .../classes/_codec_enumtype_.enumtype.html | 21 - .../classes/_codec_enumtype_.enumtype.md | 275 --- docs/types/classes/_codec_int_.int.html | 21 - docs/types/classes/_codec_int_.int.md | 95 - docs/types/classes/_codec_option_.option.html | 21 - docs/types/classes/_codec_option_.option.md | 275 --- docs/types/classes/_codec_set_.set.html | 21 - docs/types/classes/_codec_set_.set.md | 220 -- docs/types/classes/_codec_struct_.struct.html | 21 - docs/types/classes/_codec_struct_.struct.md | 356 --- docs/types/classes/_codec_tuple_.tuple.html | 21 - docs/types/classes/_codec_tuple_.tuple.md | 289 --- .../_codec_typeregistry_.typeregistry.html | 21 - .../_codec_typeregistry_.typeregistry.md | 68 - docs/types/classes/_codec_u8a_.u8a.html | 21 - docs/types/classes/_codec_u8a_.u8a.md | 217 -- .../classes/_codec_u8afixed_.u8afixed.html | 21 - .../classes/_codec_u8afixed_.u8afixed.md | 863 ------- docs/types/classes/_codec_uint_.uint.html | 21 - docs/types/classes/_codec_uint_.uint.md | 95 - docs/types/classes/_codec_vector_.vector.html | 21 - docs/types/classes/_codec_vector_.vector.md | 331 --- .../_metadata_magicnumber_.magicnumber.html | 21 - .../_metadata_magicnumber_.magicnumber.md | 2022 ---------------- .../classes/_metadata_metadata_.metadata.html | 21 - .../classes/_metadata_metadata_.metadata.md | 530 ----- ..._metadataversioned_.metadataversioned.html | 21 - ...ta_metadataversioned_.metadataversioned.md | 522 ----- ..._metadata_v0_calls_.outerdispatchcall.html | 21 - .../_metadata_v0_calls_.outerdispatchcall.md | 483 ---- ...adata_v0_calls_.outerdispatchmetadata.html | 21 - ...etadata_v0_calls_.outerdispatchmetadata.md | 470 ---- .../_metadata_v0_events_.eventmetadata.html | 21 - .../_metadata_v0_events_.eventmetadata.md | 483 ---- ...etadata_v0_events_.outereventmetadata.html | 21 - ..._metadata_v0_events_.outereventmetadata.md | 470 ---- ...ta_v0_events_.outereventmetadataevent.html | 21 - ...data_v0_events_.outereventmetadataevent.md | 1194 ---------- .../_metadata_v0_metadata_.metadatav0.html | 21 - .../_metadata_v0_metadata_.metadatav0.md | 526 ----- .../_metadata_v0_modules_.callmetadata.html | 21 - .../_metadata_v0_modules_.callmetadata.md | 470 ---- ..._v0_modules_.functionargumentmetadata.html | 21 - ...ta_v0_modules_.functionargumentmetadata.md | 470 ---- ...metadata_v0_modules_.functionmetadata.html | 21 - .../_metadata_v0_modules_.functionmetadata.md | 496 ---- .../_metadata_v0_modules_.maptype.html | 21 - .../classes/_metadata_v0_modules_.maptype.md | 470 ---- .../_metadata_v0_modules_.modulemetadata.html | 21 - .../_metadata_v0_modules_.modulemetadata.md | 470 ---- ...ata_v0_modules_.runtimemodulemetadata.html | 21 - ...adata_v0_modules_.runtimemodulemetadata.md | 483 ---- ...a_v0_modules_.storagefunctionmetadata.html | 21 - ...ata_v0_modules_.storagefunctionmetadata.md | 509 ---- ...a_v0_modules_.storagefunctionmodifier.html | 21 - ...ata_v0_modules_.storagefunctionmodifier.md | 215 -- ...adata_v0_modules_.storagefunctiontype.html | 21 - ...etadata_v0_modules_.storagefunctiontype.md | 319 --- ..._metadata_v0_modules_.storagemetadata.html | 21 - .../_metadata_v0_modules_.storagemetadata.md | 470 ---- .../_metadata_v1_calls_.metadatacall.html | 21 - .../_metadata_v1_calls_.metadatacall.md | 487 ---- .../_metadata_v1_calls_.metadatacallarg.html | 21 - .../_metadata_v1_calls_.metadatacallarg.md | 470 ---- .../_metadata_v1_events_.metadataevent.html | 21 - .../_metadata_v1_events_.metadataevent.md | 487 ---- ..._metadata_v1_metadata_.metadatamodule.html | 21 - .../_metadata_v1_metadata_.metadatamodule.md | 513 ---- .../_metadata_v1_metadata_.metadatav1.html | 21 - .../_metadata_v1_metadata_.metadatav1.md | 483 ---- .../_metadata_v1_storage_.default.html | 21 - .../classes/_metadata_v1_storage_.default.md | 145 -- .../_metadata_v1_storage_.maptype.html | 21 - .../classes/_metadata_v1_storage_.maptype.md | 470 ---- ..._metadata_v1_storage_.metadatastorage.html | 21 - .../_metadata_v1_storage_.metadatastorage.md | 513 ---- ...a_v1_storage_.metadatastoragemodifier.html | 21 - ...ata_v1_storage_.metadatastoragemodifier.md | 291 --- ...adata_v1_storage_.metadatastoragetype.html | 21 - ...etadata_v1_storage_.metadatastoragetype.md | 319 --- .../_metadata_v1_storage_.optional.html | 21 - .../classes/_metadata_v1_storage_.optional.md | 145 -- .../_metadata_v1_storage_.plaintype.html | 21 - .../_metadata_v1_storage_.plaintype.md | 1061 --------- docs/types/classes/_primitive_bool_.bool.html | 21 - docs/types/classes/_primitive_bool_.bool.md | 167 -- .../classes/_primitive_bytes_.bytes.html | 21 - docs/types/classes/_primitive_bytes_.bytes.md | 845 ------- docs/types/classes/_primitive_data_.data.html | 21 - docs/types/classes/_primitive_data_.data.md | 835 ------- docs/types/classes/_primitive_h160_.h160.html | 21 - docs/types/classes/_primitive_h160_.h160.md | 850 ------- docs/types/classes/_primitive_h256_.h256.html | 21 - docs/types/classes/_primitive_h256_.h256.md | 852 ------- docs/types/classes/_primitive_h512_.h512.html | 21 - docs/types/classes/_primitive_h512_.h512.md | 852 ------- docs/types/classes/_primitive_i128_.i128.html | 21 - docs/types/classes/_primitive_i128_.i128.md | 2026 ---------------- docs/types/classes/_primitive_i16_.i16.html | 21 - docs/types/classes/_primitive_i16_.i16.md | 2026 ---------------- docs/types/classes/_primitive_i256_.i256.html | 21 - docs/types/classes/_primitive_i256_.i256.md | 2026 ---------------- docs/types/classes/_primitive_i32_.i32.html | 21 - docs/types/classes/_primitive_i32_.i32.md | 2026 ---------------- docs/types/classes/_primitive_i64_.i64.html | 21 - docs/types/classes/_primitive_i64_.i64.md | 2026 ---------------- docs/types/classes/_primitive_i8_.i8.html | 21 - docs/types/classes/_primitive_i8_.i8.md | 2030 ---------------- .../classes/_primitive_method_.method.html | 21 - .../classes/_primitive_method_.method.md | 580 ----- .../_primitive_method_.methodindex.html | 21 - .../classes/_primitive_method_.methodindex.md | 850 ------- .../classes/_primitive_moment_.moment.html | 21 - .../classes/_primitive_moment_.moment.md | 229 -- .../classes/_primitive_moment_.momentof.html | 22 - .../classes/_primitive_moment_.momentof.md | 1053 --------- docs/types/classes/_primitive_null_.null.html | 21 - docs/types/classes/_primitive_null_.null.md | 149 -- .../_primitive_storagedata_.storagedata.html | 21 - .../_primitive_storagedata_.storagedata.md | 841 ------- .../_primitive_storagekey_.storagekey.html | 21 - .../_primitive_storagekey_.storagekey.md | 916 -------- docs/types/classes/_primitive_text_.text.html | 21 - docs/types/classes/_primitive_text_.text.md | 191 -- docs/types/classes/_primitive_type_.type.html | 21 - docs/types/classes/_primitive_type_.type.md | 1061 --------- docs/types/classes/_primitive_u128_.u128.html | 21 - docs/types/classes/_primitive_u128_.u128.md | 2028 ---------------- docs/types/classes/_primitive_u16_.u16.html | 21 - docs/types/classes/_primitive_u16_.u16.md | 2026 ---------------- docs/types/classes/_primitive_u256_.u256.html | 21 - docs/types/classes/_primitive_u256_.u256.md | 2026 ---------------- docs/types/classes/_primitive_u32_.u32.html | 21 - docs/types/classes/_primitive_u32_.u32.md | 2046 ---------------- docs/types/classes/_primitive_u64_.u64.html | 21 - docs/types/classes/_primitive_u64_.u64.md | 2034 ---------------- docs/types/classes/_primitive_u8_.u8.html | 21 - docs/types/classes/_primitive_u8_.u8.md | 2026 ---------------- .../classes/_primitive_usize_.usize.html | 21 - docs/types/classes/_primitive_usize_.usize.md | 2028 ---------------- ..._rpc_chainproperties_.chainproperties.html | 21 - .../_rpc_chainproperties_.chainproperties.md | 392 ---- .../_rpc_extrinsicstatus_.broadcast.html | 21 - .../_rpc_extrinsicstatus_.broadcast.md | 1203 ---------- .../_rpc_extrinsicstatus_.dropped.html | 21 - .../classes/_rpc_extrinsicstatus_.dropped.md | 149 -- ..._rpc_extrinsicstatus_.extrinsicstatus.html | 21 - .../_rpc_extrinsicstatus_.extrinsicstatus.md | 375 --- .../_rpc_extrinsicstatus_.finalised.html | 21 - .../_rpc_extrinsicstatus_.finalised.md | 852 ------- .../classes/_rpc_extrinsicstatus_.future.html | 21 - .../classes/_rpc_extrinsicstatus_.future.md | 149 -- .../_rpc_extrinsicstatus_.invalid.html | 21 - .../classes/_rpc_extrinsicstatus_.invalid.md | 149 -- .../classes/_rpc_extrinsicstatus_.ready.html | 21 - .../classes/_rpc_extrinsicstatus_.ready.md | 149 -- .../_rpc_extrinsicstatus_.usurped.html | 21 - .../classes/_rpc_extrinsicstatus_.usurped.md | 852 ------- docs/types/classes/_rpc_health_.health.html | 21 - docs/types/classes/_rpc_health_.health.md | 487 ---- docs/types/classes/_rpc_json_.json.html | 21 - docs/types/classes/_rpc_json_.json.md | 171 -- .../_rpc_networkstate_.networkstate.html | 21 - .../_rpc_networkstate_.networkstate.md | 366 --- .../classes/_rpc_peerinfo_.peerinfo.html | 21 - docs/types/classes/_rpc_peerinfo_.peerinfo.md | 526 ----- ..._pendingextrinsics_.pendingextrinsics.html | 21 - ...pc_pendingextrinsics_.pendingextrinsics.md | 1203 ---------- .../classes/_rpc_runtimeversion_.apiid.html | 21 - .../classes/_rpc_runtimeversion_.apiid.md | 850 ------- .../_rpc_runtimeversion_.runtimeversion.html | 21 - .../_rpc_runtimeversion_.runtimeversion.md | 527 ----- ...rpc_runtimeversion_.runtimeversionapi.html | 21 - .../_rpc_runtimeversion_.runtimeversionapi.md | 1198 ---------- .../_rpc_signedblock_.signedblock.html | 21 - .../classes/_rpc_signedblock_.signedblock.md | 487 ---- ...pc_storagechangeset_.storagechangeset.html | 21 - ..._rpc_storagechangeset_.storagechangeset.md | 474 ---- .../classes/_type_accountid_.accountid.html | 21 - .../classes/_type_accountid_.accountid.md | 869 ------- .../classes/_type_accountid_.accountidof.html | 21 - .../classes/_type_accountid_.accountidof.md | 875 ------- .../_type_accountindex_.accountindex.html | 21 - .../_type_accountindex_.accountindex.md | 2084 ----------------- .../types/classes/_type_address_.address.html | 21 - docs/types/classes/_type_address_.address.md | 187 -- docs/types/classes/_type_amount_.amount.html | 21 - docs/types/classes/_type_amount_.amount.md | 2028 ---------------- .../types/classes/_type_assetof_.assetof.html | 21 - docs/types/classes/_type_assetof_.assetof.md | 2028 ---------------- ..._attestedcandidate_.attestedcandidate.html | 21 - ...pe_attestedcandidate_.attestedcandidate.md | 448 ---- ...e_attestedcandidate_.availabilityvote.html | 21 - ...ype_attestedcandidate_.availabilityvote.md | 1169 --------- ...type_attestedcandidate_.balanceupload.html | 21 - .../_type_attestedcandidate_.balanceupload.md | 1169 --------- ...e_attestedcandidate_.candidatereceipt.html | 21 - ...ype_attestedcandidate_.candidatereceipt.md | 444 ---- ...attestedcandidate_.candidatesignature.html | 21 - ...e_attestedcandidate_.candidatesignature.md | 852 ------- ...pe_attestedcandidate_.egressqueueroot.html | 21 - ...type_attestedcandidate_.egressqueueroot.md | 1169 --------- ...candidate_.explicitcandidatesignature.html | 21 - ...edcandidate_.explicitcandidatesignature.md | 848 ------- .../_type_attestedcandidate_.headdata.html | 21 - .../_type_attestedcandidate_.headdata.md | 837 ------- ...candidate_.implicitcandidatesignature.html | 21 - ...edcandidate_.implicitcandidatesignature.md | 848 ------- ...ttestedcandidate_.validityattestation.html | 21 - ..._attestedcandidate_.validityattestation.md | 305 --- ..._type_attestedcandidate_.validityvote.html | 21 - .../_type_attestedcandidate_.validityvote.md | 1169 --------- .../_type_authorityid_.authorityid.html | 21 - .../classes/_type_authorityid_.authorityid.md | 873 ------- .../types/classes/_type_balance_.balance.html | 21 - docs/types/classes/_type_balance_.balance.md | 2034 ---------------- .../classes/_type_balance_.balanceof.html | 21 - .../types/classes/_type_balance_.balanceof.md | 2028 ---------------- .../_type_bft_.bftauthoritysignature.html | 21 - .../_type_bft_.bftauthoritysignature.md | 1198 ---------- .../classes/_type_bft_.bfthashsignature.html | 21 - .../classes/_type_bft_.bfthashsignature.md | 1198 ---------- docs/types/classes/_type_block_.block.html | 21 - docs/types/classes/_type_block_.block.md | 500 ---- .../_type_blocknumber_.blocknumber.html | 21 - .../classes/_type_blocknumber_.blocknumber.md | 2028 ---------------- .../classes/_type_codehash_.codehash.html | 21 - .../types/classes/_type_codehash_.codehash.md | 852 ------- .../_type_digest_.authoritieschange.html | 21 - .../_type_digest_.authoritieschange.md | 1203 ---------- .../_type_digest_.changestrieroot.html | 21 - .../classes/_type_digest_.changestrieroot.md | 852 ------- docs/types/classes/_type_digest_.digest.html | 21 - docs/types/classes/_type_digest_.digest.md | 461 ---- .../classes/_type_digest_.digestitem.html | 21 - .../types/classes/_type_digest_.digestitem.md | 335 --- docs/types/classes/_type_digest_.other.html | 21 - docs/types/classes/_type_digest_.other.md | 841 ------- docs/types/classes/_type_digest_.seal.html | 21 - docs/types/classes/_type_digest_.seal.md | 1198 ---------- docs/types/classes/_type_event_.event.html | 21 - docs/types/classes/_type_event_.event.md | 560 ----- .../types/classes/_type_event_.eventdata.html | 21 - docs/types/classes/_type_event_.eventdata.md | 1229 ---------- .../classes/_type_event_.eventindex.html | 21 - docs/types/classes/_type_event_.eventindex.md | 850 ------- .../_type_eventrecord_.applyextrinsic.html | 21 - .../_type_eventrecord_.applyextrinsic.md | 2028 ---------------- .../_type_eventrecord_.eventrecord.html | 21 - .../classes/_type_eventrecord_.eventrecord.md | 474 ---- .../_type_eventrecord_.finalization.html | 21 - .../_type_eventrecord_.finalization.md | 149 -- .../classes/_type_eventrecord_.phase.html | 21 - .../types/classes/_type_eventrecord_.phase.md | 310 --- .../classes/_type_extrinsic_.extrinsic.html | 21 - .../classes/_type_extrinsic_.extrinsic.md | 631 ----- .../_type_extrinsicera_.extrinsicera.html | 21 - .../_type_extrinsicera_.extrinsicera.md | 852 ------- .../classes/_type_extrinsics_.extrinsics.html | 21 - .../classes/_type_extrinsics_.extrinsics.md | 1205 ---------- ...xtrinsicsignature_.extrinsicsignature.html | 21 - ..._extrinsicsignature_.extrinsicsignature.md | 586 ----- docs/types/classes/_type_gas_.gas.html | 21 - docs/types/classes/_type_gas_.gas.md | 2028 ---------------- docs/types/classes/_type_hash_.hash.html | 21 - docs/types/classes/_type_hash_.hash.md | 862 ------- docs/types/classes/_type_header_.header.html | 21 - docs/types/classes/_type_header_.header.md | 528 ----- .../classes/_type_header_.headerextended.html | 21 - .../classes/_type_header_.headerextended.md | 552 ----- ...tofflinereport_.inherentofflinereport.html | 21 - ...entofflinereport_.inherentofflinereport.md | 1173 ---------- .../_type_justification_.justification.html | 21 - .../_type_justification_.justification.md | 841 ------- ..._type_justification_.rhdjustification.html | 21 - .../_type_justification_.rhdjustification.md | 487 ---- .../classes/_type_keyvalue_.keyvalue.html | 21 - .../types/classes/_type_keyvalue_.keyvalue.md | 474 ---- .../_type_keyvalue_.keyvalueoption.html | 21 - .../classes/_type_keyvalue_.keyvalueoption.md | 1198 ---------- .../_type_lockperiods_.lockperiods.html | 21 - .../classes/_type_lockperiods_.lockperiods.md | 2028 ---------------- .../_type_misbehaviorreport_.bftatreport.html | 21 - .../_type_misbehaviorreport_.bftatreport.md | 493 ---- ...pe_misbehaviorreport_.bftdoublecommit.html | 21 - ...type_misbehaviorreport_.bftdoublecommit.md | 495 ---- ...e_misbehaviorreport_.bftdoubleprepare.html | 21 - ...ype_misbehaviorreport_.bftdoubleprepare.md | 495 ---- ...e_misbehaviorreport_.bftdoublepropose.html | 21 - ...ype_misbehaviorreport_.bftdoublepropose.md | 495 ---- ...isbehaviorreport_.bftproposeoutofturn.html | 21 - ..._misbehaviorreport_.bftproposeoutofturn.md | 474 ---- ...pe_misbehaviorreport_.misbehaviorkind.html | 21 - ...type_misbehaviorreport_.misbehaviorkind.md | 336 --- ..._misbehaviorreport_.misbehaviorreport.html | 21 - ...pe_misbehaviorreport_.misbehaviorreport.md | 500 ---- ..._newaccountoutcome_.newaccountoutcome.html | 21 - ...pe_newaccountoutcome_.newaccountoutcome.md | 206 -- docs/types/classes/_type_nonce_.nonce.html | 21 - docs/types/classes/_type_nonce_.nonce.md | 2028 ---------------- .../_type_noncecompact_.noncecompact.html | 21 - .../_type_noncecompact_.noncecompact.md | 333 --- docs/types/classes/_type_origin_.origin.html | 21 - docs/types/classes/_type_origin_.origin.md | 163 -- docs/types/classes/_type_paraid_.paraid.html | 21 - docs/types/classes/_type_paraid_.paraid.md | 2028 ---------------- .../types/classes/_type_perbill_.perbill.html | 21 - docs/types/classes/_type_perbill_.perbill.md | 2028 ---------------- .../types/classes/_type_permill_.permill.html | 21 - docs/types/classes/_type_permill_.permill.md | 2028 ---------------- ...pe_prefabwasmmodule_.prefabwasmmodule.html | 21 - ...type_prefabwasmmodule_.prefabwasmmodule.md | 500 ---- .../classes/_type_propindex_.propindex.html | 21 - .../classes/_type_propindex_.propindex.md | 2028 ---------------- .../classes/_type_proposal_.proposal.html | 21 - .../types/classes/_type_proposal_.proposal.md | 598 ----- .../_type_proposalindex_.proposalindex.html | 21 - .../_type_proposalindex_.proposalindex.md | 2028 ---------------- ...type_referendumindex_.referendumindex.html | 21 - .../_type_referendumindex_.referendumindex.md | 2028 ---------------- .../_type_referenduminfo_.referenduminfo.html | 21 - .../_type_referenduminfo_.referenduminfo.md | 500 ---- .../classes/_type_schedule_.schedule.html | 21 - .../types/classes/_type_schedule_.schedule.md | 565 ----- docs/types/classes/_type_seedof_.seedof.html | 21 - docs/types/classes/_type_seedof_.seedof.md | 852 ------- .../classes/_type_sessionkey_.sessionkey.html | 21 - .../classes/_type_sessionkey_.sessionkey.md | 875 ------- .../_type_signature_.ed25519signature.html | 21 - .../_type_signature_.ed25519signature.md | 852 ------- .../classes/_type_signature_.signature.html | 21 - .../classes/_type_signature_.signature.md | 858 ------- .../_type_signature_.sr25519signature.html | 21 - .../_type_signature_.sr25519signature.md | 852 ------- ...pe_signaturepayload_.signaturepayload.html | 21 - ...type_signaturepayload_.signaturepayload.md | 548 ----- ...pe_storedpendingchange_.nextauthority.html | 21 - ...type_storedpendingchange_.nextauthority.md | 1194 ---------- ...redpendingchange_.storedpendingchange.html | 21 - ...toredpendingchange_.storedpendingchange.md | 481 ---- .../_type_validatorprefs_.validatorprefs.html | 21 - .../_type_validatorprefs_.validatorprefs.md | 474 ---- ...type_vestingschedule_.vestingschedule.html | 21 - .../_type_vestingschedule_.vestingschedule.md | 474 ---- docs/types/classes/_type_vote_.vote.html | 21 - docs/types/classes/_type_vote_.vote.md | 2052 ---------------- .../classes/_type_voteindex_.voteindex.html | 21 - .../classes/_type_voteindex_.voteindex.md | 2028 ---------------- .../_type_votethreshold_.votethreshold.html | 21 - .../_type_votethreshold_.votethreshold.md | 206 -- .../enums/_codec_createtype_.typedefinfo.html | 21 - .../enums/_codec_createtype_.typedefinfo.md | 82 - docs/types/index.html | 29 - .../_metadata_types_.metadatainterface.html | 21 - .../_metadata_types_.metadatainterface.md | 33 - .../_primitive_method_.methodfunction.html | 21 - .../_primitive_method_.methodfunction.md | 72 - .../_primitive_method_.methods.html | 21 - .../interfaces/_primitive_method_.methods.md | 9 - ..._primitive_method_.moduleswithmethods.html | 21 - .../_primitive_method_.moduleswithmethods.md | 9 - ...primitive_storagekey_.storagefunction.html | 21 - .../_primitive_storagekey_.storagefunction.md | 63 - docs/types/interfaces/_types_.codec.html | 21 - docs/types/interfaces/_types_.codec.md | 294 --- .../types/interfaces/_types_.constructor.html | 21 - docs/types/interfaces/_types_.constructor.md | 28 - .../_types_.runtimeversioninterface.html | 21 - .../_types_.runtimeversioninterface.md | 67 - docs/types/modules/_classes_.html | 21 - docs/types/modules/_classes_.md | 14 - docs/types/modules/_codec_abstractint_.html | 21 - docs/types/modules/_codec_abstractint_.md | 26 - docs/types/modules/_codec_base_.html | 21 - docs/types/modules/_codec_base_.md | 10 - docs/types/modules/_codec_compact_.html | 21 - docs/types/modules/_codec_compact_.md | 10 - docs/types/modules/_codec_createtype_.html | 21 - docs/types/modules/_codec_createtype_.md | 127 - docs/types/modules/_codec_enum_.html | 21 - docs/types/modules/_codec_enum_.md | 10 - docs/types/modules/_codec_enumtype_.html | 21 - docs/types/modules/_codec_enumtype_.md | 10 - docs/types/modules/_codec_int_.html | 21 - docs/types/modules/_codec_int_.md | 10 - docs/types/modules/_codec_option_.html | 21 - docs/types/modules/_codec_option_.md | 10 - docs/types/modules/_codec_set_.html | 21 - docs/types/modules/_codec_set_.md | 10 - docs/types/modules/_codec_struct_.html | 21 - docs/types/modules/_codec_struct_.md | 10 - docs/types/modules/_codec_tuple_.html | 21 - docs/types/modules/_codec_tuple_.md | 10 - docs/types/modules/_codec_typeregistry_.html | 21 - docs/types/modules/_codec_typeregistry_.md | 10 - docs/types/modules/_codec_u8a_.html | 21 - docs/types/modules/_codec_u8a_.md | 10 - docs/types/modules/_codec_u8afixed_.html | 21 - docs/types/modules/_codec_u8afixed_.md | 10 - docs/types/modules/_codec_uint_.html | 21 - docs/types/modules/_codec_uint_.md | 10 - .../modules/_codec_utils_comparearray_.html | 21 - .../modules/_codec_utils_comparearray_.md | 23 - .../modules/_codec_utils_comparemap_.html | 21 - .../types/modules/_codec_utils_comparemap_.md | 23 - .../modules/_codec_utils_decodeu8a_.html | 21 - docs/types/modules/_codec_utils_decodeu8a_.md | 25 - docs/types/modules/_codec_vector_.html | 21 - docs/types/modules/_codec_vector_.md | 10 - docs/types/modules/_index_types_.html | 21 - docs/types/modules/_index_types_.md | 2 - .../types/modules/_metadata_magicnumber_.html | 21 - docs/types/modules/_metadata_magicnumber_.md | 36 - docs/types/modules/_metadata_metadata_.html | 21 - docs/types/modules/_metadata_metadata_.md | 10 - .../modules/_metadata_metadataversioned_.html | 21 - .../modules/_metadata_metadataversioned_.md | 10 - docs/types/modules/_metadata_static_.html | 21 - docs/types/modules/_metadata_static_.md | 2 - docs/types/modules/_metadata_types_.html | 21 - docs/types/modules/_metadata_types_.md | 10 - .../modules/_metadata_util_flattenuniq_.html | 21 - .../modules/_metadata_util_flattenuniq_.md | 22 - .../_metadata_util_validatetypes_.html | 21 - .../modules/_metadata_util_validatetypes_.md | 23 - docs/types/modules/_metadata_v0_calls_.html | 21 - docs/types/modules/_metadata_v0_calls_.md | 11 - docs/types/modules/_metadata_v0_events_.html | 21 - docs/types/modules/_metadata_v0_events_.md | 12 - .../types/modules/_metadata_v0_metadata_.html | 21 - docs/types/modules/_metadata_v0_metadata_.md | 10 - docs/types/modules/_metadata_v0_modules_.html | 21 - docs/types/modules/_metadata_v0_modules_.md | 19 - docs/types/modules/_metadata_v0_static_.html | 21 - docs/types/modules/_metadata_v0_static_.md | 2 - docs/types/modules/_metadata_v1_calls_.html | 21 - docs/types/modules/_metadata_v1_calls_.md | 11 - docs/types/modules/_metadata_v1_events_.html | 21 - docs/types/modules/_metadata_v1_events_.md | 10 - .../types/modules/_metadata_v1_metadata_.html | 21 - docs/types/modules/_metadata_v1_metadata_.md | 11 - docs/types/modules/_metadata_v1_static_.html | 21 - docs/types/modules/_metadata_v1_static_.md | 2 - docs/types/modules/_metadata_v1_storage_.html | 21 - docs/types/modules/_metadata_v1_storage_.md | 16 - docs/types/modules/_metadata_v1_tov0_.html | 21 - docs/types/modules/_metadata_v1_tov0_.md | 22 - docs/types/modules/_primitive_bool_.html | 21 - docs/types/modules/_primitive_bool_.md | 10 - docs/types/modules/_primitive_bytes_.html | 21 - docs/types/modules/_primitive_bytes_.md | 10 - docs/types/modules/_primitive_data_.html | 21 - docs/types/modules/_primitive_data_.md | 10 - docs/types/modules/_primitive_h160_.html | 21 - docs/types/modules/_primitive_h160_.md | 10 - docs/types/modules/_primitive_h256_.html | 21 - docs/types/modules/_primitive_h256_.md | 10 - docs/types/modules/_primitive_h512_.html | 21 - docs/types/modules/_primitive_h512_.md | 10 - docs/types/modules/_primitive_i128_.html | 21 - docs/types/modules/_primitive_i128_.md | 10 - docs/types/modules/_primitive_i16_.html | 21 - docs/types/modules/_primitive_i16_.md | 10 - docs/types/modules/_primitive_i256_.html | 21 - docs/types/modules/_primitive_i256_.md | 10 - docs/types/modules/_primitive_i32_.html | 21 - docs/types/modules/_primitive_i32_.md | 10 - docs/types/modules/_primitive_i64_.html | 21 - docs/types/modules/_primitive_i64_.md | 10 - docs/types/modules/_primitive_i8_.html | 21 - docs/types/modules/_primitive_i8_.md | 10 - docs/types/modules/_primitive_method_.html | 21 - docs/types/modules/_primitive_method_.md | 17 - docs/types/modules/_primitive_moment_.html | 21 - docs/types/modules/_primitive_moment_.md | 11 - docs/types/modules/_primitive_null_.html | 21 - docs/types/modules/_primitive_null_.md | 10 - .../modules/_primitive_storagedata_.html | 21 - docs/types/modules/_primitive_storagedata_.md | 10 - .../types/modules/_primitive_storagekey_.html | 21 - docs/types/modules/_primitive_storagekey_.md | 14 - docs/types/modules/_primitive_text_.html | 21 - docs/types/modules/_primitive_text_.md | 10 - docs/types/modules/_primitive_type_.html | 21 - docs/types/modules/_primitive_type_.md | 10 - docs/types/modules/_primitive_u128_.html | 21 - docs/types/modules/_primitive_u128_.md | 10 - docs/types/modules/_primitive_u16_.html | 21 - docs/types/modules/_primitive_u16_.md | 10 - docs/types/modules/_primitive_u256_.html | 21 - docs/types/modules/_primitive_u256_.md | 10 - docs/types/modules/_primitive_u32_.html | 21 - docs/types/modules/_primitive_u32_.md | 10 - docs/types/modules/_primitive_u64_.html | 21 - docs/types/modules/_primitive_u64_.md | 10 - docs/types/modules/_primitive_u8_.html | 21 - docs/types/modules/_primitive_u8_.md | 10 - docs/types/modules/_primitive_usize_.html | 21 - docs/types/modules/_primitive_usize_.md | 10 - docs/types/modules/_rpc_chainproperties_.html | 21 - docs/types/modules/_rpc_chainproperties_.md | 10 - docs/types/modules/_rpc_extrinsicstatus_.html | 21 - docs/types/modules/_rpc_extrinsicstatus_.md | 17 - docs/types/modules/_rpc_health_.html | 21 - docs/types/modules/_rpc_health_.md | 10 - docs/types/modules/_rpc_json_.html | 21 - docs/types/modules/_rpc_json_.md | 10 - docs/types/modules/_rpc_networkstate_.html | 21 - docs/types/modules/_rpc_networkstate_.md | 10 - docs/types/modules/_rpc_peerinfo_.html | 21 - docs/types/modules/_rpc_peerinfo_.md | 10 - .../modules/_rpc_pendingextrinsics_.html | 21 - docs/types/modules/_rpc_pendingextrinsics_.md | 10 - docs/types/modules/_rpc_runtimeversion_.html | 21 - docs/types/modules/_rpc_runtimeversion_.md | 12 - docs/types/modules/_rpc_signedblock_.html | 21 - docs/types/modules/_rpc_signedblock_.md | 10 - .../types/modules/_rpc_storagechangeset_.html | 21 - docs/types/modules/_rpc_storagechangeset_.md | 10 - docs/types/modules/_scripts_metadatamd_.html | 21 - docs/types/modules/_scripts_metadatamd_.md | 2 - docs/types/modules/_type_accountid_.html | 21 - docs/types/modules/_type_accountid_.md | 11 - docs/types/modules/_type_accountindex_.html | 21 - docs/types/modules/_type_accountindex_.md | 26 - docs/types/modules/_type_address_.html | 21 - docs/types/modules/_type_address_.md | 26 - docs/types/modules/_type_amount_.html | 21 - docs/types/modules/_type_amount_.md | 10 - docs/types/modules/_type_assetof_.html | 21 - docs/types/modules/_type_assetof_.md | 10 - .../modules/_type_attestedcandidate_.html | 21 - .../types/modules/_type_attestedcandidate_.md | 20 - docs/types/modules/_type_authorityid_.html | 21 - docs/types/modules/_type_authorityid_.md | 10 - docs/types/modules/_type_balance_.html | 21 - docs/types/modules/_type_balance_.md | 11 - docs/types/modules/_type_bft_.html | 21 - docs/types/modules/_type_bft_.md | 37 - docs/types/modules/_type_block_.html | 21 - docs/types/modules/_type_block_.md | 28 - docs/types/modules/_type_blocknumber_.html | 21 - docs/types/modules/_type_blocknumber_.md | 10 - docs/types/modules/_type_codehash_.html | 21 - docs/types/modules/_type_codehash_.md | 10 - docs/types/modules/_type_digest_.html | 21 - docs/types/modules/_type_digest_.md | 15 - docs/types/modules/_type_event_.html | 21 - docs/types/modules/_type_event_.md | 12 - docs/types/modules/_type_eventrecord_.html | 21 - docs/types/modules/_type_eventrecord_.md | 13 - docs/types/modules/_type_extrinsic_.html | 21 - docs/types/modules/_type_extrinsic_.md | 10 - docs/types/modules/_type_extrinsicera_.html | 21 - docs/types/modules/_type_extrinsicera_.md | 10 - docs/types/modules/_type_extrinsics_.html | 21 - docs/types/modules/_type_extrinsics_.md | 10 - .../modules/_type_extrinsicsignature_.html | 21 - .../modules/_type_extrinsicsignature_.md | 26 - docs/types/modules/_type_gas_.html | 21 - docs/types/modules/_type_gas_.md | 10 - docs/types/modules/_type_hash_.html | 21 - docs/types/modules/_type_hash_.md | 10 - docs/types/modules/_type_header_.html | 21 - docs/types/modules/_type_header_.md | 29 - .../modules/_type_inherentofflinereport_.html | 21 - .../modules/_type_inherentofflinereport_.md | 10 - docs/types/modules/_type_justification_.html | 21 - docs/types/modules/_type_justification_.md | 29 - docs/types/modules/_type_keyvalue_.html | 21 - docs/types/modules/_type_keyvalue_.md | 27 - docs/types/modules/_type_lockperiods_.html | 21 - docs/types/modules/_type_lockperiods_.md | 10 - .../modules/_type_misbehaviorreport_.html | 21 - .../types/modules/_type_misbehaviorreport_.md | 16 - .../modules/_type_newaccountoutcome_.html | 21 - .../types/modules/_type_newaccountoutcome_.md | 10 - docs/types/modules/_type_nonce_.html | 21 - docs/types/modules/_type_nonce_.md | 10 - docs/types/modules/_type_noncecompact_.html | 21 - docs/types/modules/_type_noncecompact_.md | 10 - docs/types/modules/_type_origin_.html | 21 - docs/types/modules/_type_origin_.md | 10 - docs/types/modules/_type_paraid_.html | 21 - docs/types/modules/_type_paraid_.md | 10 - docs/types/modules/_type_perbill_.html | 21 - docs/types/modules/_type_perbill_.md | 10 - docs/types/modules/_type_permill_.html | 21 - docs/types/modules/_type_permill_.md | 10 - .../modules/_type_prefabwasmmodule_.html | 21 - docs/types/modules/_type_prefabwasmmodule_.md | 10 - docs/types/modules/_type_propindex_.html | 21 - docs/types/modules/_type_propindex_.md | 10 - docs/types/modules/_type_proposal_.html | 21 - docs/types/modules/_type_proposal_.md | 10 - docs/types/modules/_type_proposalindex_.html | 21 - docs/types/modules/_type_proposalindex_.md | 10 - .../types/modules/_type_referendumindex_.html | 21 - docs/types/modules/_type_referendumindex_.md | 10 - docs/types/modules/_type_referenduminfo_.html | 21 - docs/types/modules/_type_referenduminfo_.md | 10 - docs/types/modules/_type_schedule_.html | 21 - docs/types/modules/_type_schedule_.md | 10 - docs/types/modules/_type_seedof_.html | 21 - docs/types/modules/_type_seedof_.md | 10 - docs/types/modules/_type_sessionkey_.html | 21 - docs/types/modules/_type_sessionkey_.md | 10 - docs/types/modules/_type_signature_.html | 21 - docs/types/modules/_type_signature_.md | 12 - .../modules/_type_signaturepayload_.html | 21 - docs/types/modules/_type_signaturepayload_.md | 10 - .../modules/_type_storedpendingchange_.html | 21 - .../modules/_type_storedpendingchange_.md | 41 - docs/types/modules/_type_validatorprefs_.html | 21 - docs/types/modules/_type_validatorprefs_.md | 10 - .../types/modules/_type_vestingschedule_.html | 21 - docs/types/modules/_type_vestingschedule_.md | 10 - docs/types/modules/_type_vote_.html | 21 - docs/types/modules/_type_vote_.md | 10 - docs/types/modules/_type_voteindex_.html | 21 - docs/types/modules/_type_voteindex_.md | 10 - docs/types/modules/_type_votethreshold_.html | 21 - docs/types/modules/_type_votethreshold_.md | 10 - docs/types/modules/_types_.html | 21 - docs/types/modules/_types_.md | 143 -- 1347 files changed, 172998 deletions(-) delete mode 100644 docs/404.html delete mode 100644 docs/CONTRIBUTING.html delete mode 100644 docs/METHODS_EVENTS.html delete mode 100644 docs/METHODS_EXTRINSICS.html delete mode 100644 docs/METHODS_RPC.html delete mode 100644 docs/METHODS_STORAGE.html delete mode 100644 docs/SUMMARY.html delete mode 100644 docs/api-derive/README.md delete mode 100644 docs/api-derive/SUMMARY.html delete mode 100644 docs/api-derive/SUMMARY.md delete mode 100644 docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html delete mode 100644 docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md delete mode 100644 docs/api-derive/index.html delete mode 100644 docs/api-derive/modules/_accounts_idandindex_.html delete mode 100644 docs/api-derive/modules/_accounts_idandindex_.md delete mode 100644 docs/api-derive/modules/_accounts_idtoindex_.html delete mode 100644 docs/api-derive/modules/_accounts_idtoindex_.md delete mode 100644 docs/api-derive/modules/_accounts_indexes_.html delete mode 100644 docs/api-derive/modules/_accounts_indexes_.md delete mode 100644 docs/api-derive/modules/_accounts_indextoid_.html delete mode 100644 docs/api-derive/modules/_accounts_indextoid_.md delete mode 100644 docs/api-derive/modules/_balances_fees_.html delete mode 100644 docs/api-derive/modules/_balances_fees_.md delete mode 100644 docs/api-derive/modules/_balances_validatingbalance_.html delete mode 100644 docs/api-derive/modules/_balances_validatingbalance_.md delete mode 100644 docs/api-derive/modules/_balances_validatingbalances_.html delete mode 100644 docs/api-derive/modules/_balances_validatingbalances_.md delete mode 100644 docs/api-derive/modules/_balances_votingbalance_.html delete mode 100644 docs/api-derive/modules/_balances_votingbalance_.md delete mode 100644 docs/api-derive/modules/_balances_votingbalances_.html delete mode 100644 docs/api-derive/modules/_balances_votingbalances_.md delete mode 100644 docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.html delete mode 100644 docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md delete mode 100644 docs/api-derive/modules/_chain_bestnumber_.html delete mode 100644 docs/api-derive/modules/_chain_bestnumber_.md delete mode 100644 docs/api-derive/modules/_chain_bestnumberfinalised_.html delete mode 100644 docs/api-derive/modules/_chain_bestnumberfinalised_.md delete mode 100644 docs/api-derive/modules/_chain_bestnumberlag_.html delete mode 100644 docs/api-derive/modules/_chain_bestnumberlag_.md delete mode 100644 docs/api-derive/modules/_chain_getheader_.html delete mode 100644 docs/api-derive/modules/_chain_getheader_.md delete mode 100644 docs/api-derive/modules/_chain_subscribenewhead_.html delete mode 100644 docs/api-derive/modules/_chain_subscribenewhead_.md delete mode 100644 docs/api-derive/modules/_democracy_referenduminfo_.html delete mode 100644 docs/api-derive/modules/_democracy_referenduminfo_.md delete mode 100644 docs/api-derive/modules/_democracy_referenduminfos_.html delete mode 100644 docs/api-derive/modules/_democracy_referenduminfos_.md delete mode 100644 docs/api-derive/modules/_democracy_referendums_.html delete mode 100644 docs/api-derive/modules/_democracy_referendums_.md delete mode 100644 docs/api-derive/modules/_democracy_referendumvotesfor_.html delete mode 100644 docs/api-derive/modules/_democracy_referendumvotesfor_.md delete mode 100644 docs/api-derive/modules/_democracy_votes_.html delete mode 100644 docs/api-derive/modules/_democracy_votes_.md delete mode 100644 docs/api-derive/modules/_session_eralength_.html delete mode 100644 docs/api-derive/modules/_session_eralength_.md delete mode 100644 docs/api-derive/modules/_session_eraprogress_.html delete mode 100644 docs/api-derive/modules/_session_eraprogress_.md delete mode 100644 docs/api-derive/modules/_session_sessionprogress_.html delete mode 100644 docs/api-derive/modules/_session_sessionprogress_.md delete mode 100644 docs/api-derive/modules/_staking_intentionsbalances_.html delete mode 100644 docs/api-derive/modules/_staking_intentionsbalances_.md delete mode 100644 docs/api-derive/modules/_types_.html delete mode 100644 docs/api-derive/modules/_types_.md delete mode 100644 docs/api-derive/modules/_util_cache_.html delete mode 100644 docs/api-derive/modules/_util_cache_.md delete mode 100644 docs/api-derive/modules/_util_drr_.html delete mode 100644 docs/api-derive/modules/_util_drr_.md delete mode 100644 docs/api/README.md delete mode 100644 docs/api/SUMMARY.html delete mode 100644 docs/api/SUMMARY.md delete mode 100644 docs/api/classes/_base_.apibase.html delete mode 100644 docs/api/classes/_base_.apibase.md delete mode 100644 docs/api/classes/_promise_api_.apipromise.html delete mode 100644 docs/api/classes/_promise_api_.apipromise.md delete mode 100644 docs/api/classes/_promise_combinator_.combinator.html delete mode 100644 docs/api/classes/_promise_combinator_.combinator.md delete mode 100644 docs/api/classes/_rx_api_.apirx.html delete mode 100644 docs/api/classes/_rx_api_.apirx.md delete mode 100644 docs/api/classes/_submittableextrinsic_.submittableextrinsic.html delete mode 100644 docs/api/classes/_submittableextrinsic_.submittableextrinsic.md delete mode 100644 docs/api/classes/_submittableextrinsic_.submittableresult.html delete mode 100644 docs/api/classes/_submittableextrinsic_.submittableresult.md delete mode 100644 docs/api/index.html delete mode 100644 docs/api/interfaces/_promise_types_.apipromiseinterface.html delete mode 100644 docs/api/interfaces/_promise_types_.apipromiseinterface.md delete mode 100644 docs/api/interfaces/_rx_types_.apirxinterface.html delete mode 100644 docs/api/interfaces/_rx_types_.apirxinterface.md delete mode 100644 docs/api/interfaces/_types_.apibaseinterface.html delete mode 100644 docs/api/interfaces/_types_.apibaseinterface.md delete mode 100644 docs/api/interfaces/_types_.apiinterface_decorated.html delete mode 100644 docs/api/interfaces/_types_.apiinterface_decorated.md delete mode 100644 docs/api/interfaces/_types_.apioptions.html delete mode 100644 docs/api/interfaces/_types_.apioptions.md delete mode 100644 docs/api/interfaces/_types_.decoratedrpc.html delete mode 100644 docs/api/interfaces/_types_.decoratedrpc.md delete mode 100644 docs/api/interfaces/_types_.decoratedrpc_method.html delete mode 100644 docs/api/interfaces/_types_.decoratedrpc_method.md delete mode 100644 docs/api/interfaces/_types_.decoratedrpc_section.html delete mode 100644 docs/api/interfaces/_types_.decoratedrpc_section.md delete mode 100644 docs/api/interfaces/_types_.derive.html delete mode 100644 docs/api/interfaces/_types_.derive.md delete mode 100644 docs/api/interfaces/_types_.derivemethodbase.html delete mode 100644 docs/api/interfaces/_types_.derivemethodbase.md delete mode 100644 docs/api/interfaces/_types_.derivesection.html delete mode 100644 docs/api/interfaces/_types_.derivesection.md delete mode 100644 docs/api/interfaces/_types_.queryablemodulestorage.html delete mode 100644 docs/api/interfaces/_types_.queryablemodulestorage.md delete mode 100644 docs/api/interfaces/_types_.queryablestorage.html delete mode 100644 docs/api/interfaces/_types_.queryablestorage.md delete mode 100644 docs/api/interfaces/_types_.queryablestoragefunctionbase.html delete mode 100644 docs/api/interfaces/_types_.queryablestoragefunctionbase.md delete mode 100644 docs/api/interfaces/_types_.signer.html delete mode 100644 docs/api/interfaces/_types_.signer.md delete mode 100644 docs/api/interfaces/_types_.submittableextrinsicfunction.html delete mode 100644 docs/api/interfaces/_types_.submittableextrinsicfunction.md delete mode 100644 docs/api/interfaces/_types_.submittableextrinsics.html delete mode 100644 docs/api/interfaces/_types_.submittableextrinsics.md delete mode 100644 docs/api/interfaces/_types_.submittablemoduleextrinsics.html delete mode 100644 docs/api/interfaces/_types_.submittablemoduleextrinsics.md delete mode 100644 docs/api/modules/_base_.html delete mode 100644 docs/api/modules/_base_.md delete mode 100644 docs/api/modules/_checktypes_manual_.html delete mode 100644 docs/api/modules/_checktypes_manual_.md delete mode 100644 docs/api/modules/_promise_api_.html delete mode 100644 docs/api/modules/_promise_api_.md delete mode 100644 docs/api/modules/_promise_combinator_.html delete mode 100644 docs/api/modules/_promise_combinator_.md delete mode 100644 docs/api/modules/_promise_types_.html delete mode 100644 docs/api/modules/_promise_types_.md delete mode 100644 docs/api/modules/_rx_api_.html delete mode 100644 docs/api/modules/_rx_api_.md delete mode 100644 docs/api/modules/_rx_types_.html delete mode 100644 docs/api/modules/_rx_types_.md delete mode 100644 docs/api/modules/_submittableextrinsic_.html delete mode 100644 docs/api/modules/_submittableextrinsic_.md delete mode 100644 docs/api/modules/_types_.html delete mode 100644 docs/api/modules/_types_.md delete mode 100644 docs/api/modules/_util_filterevents_.html delete mode 100644 docs/api/modules/_util_filterevents_.md delete mode 100644 docs/api/modules/_util_logging_.html delete mode 100644 docs/api/modules/_util_logging_.md delete mode 100644 docs/assets/css/0.styles.22f13802.css delete mode 100644 docs/assets/img/search.83621669.svg delete mode 100644 docs/assets/js/10.730dd1f8.js delete mode 100644 docs/assets/js/100.ca511823.js delete mode 100644 docs/assets/js/101.553ffa55.js delete mode 100644 docs/assets/js/102.0da1ec79.js delete mode 100644 docs/assets/js/103.1f02833f.js delete mode 100644 docs/assets/js/104.85ac0811.js delete mode 100644 docs/assets/js/105.7e80c03b.js delete mode 100644 docs/assets/js/106.5e6f31b1.js delete mode 100644 docs/assets/js/107.5f08e115.js delete mode 100644 docs/assets/js/108.643f37cd.js delete mode 100644 docs/assets/js/109.2bfc3f88.js delete mode 100644 docs/assets/js/11.16564673.js delete mode 100644 docs/assets/js/110.391cd976.js delete mode 100644 docs/assets/js/111.247898ab.js delete mode 100644 docs/assets/js/112.1979bc80.js delete mode 100644 docs/assets/js/113.4097126a.js delete mode 100644 docs/assets/js/114.7c298e55.js delete mode 100644 docs/assets/js/115.0568f994.js delete mode 100644 docs/assets/js/116.7c28a393.js delete mode 100644 docs/assets/js/117.bf1a2cc6.js delete mode 100644 docs/assets/js/118.b1c65641.js delete mode 100644 docs/assets/js/119.21ea0a94.js delete mode 100644 docs/assets/js/12.23b26fea.js delete mode 100644 docs/assets/js/120.32f79155.js delete mode 100644 docs/assets/js/121.84147bfd.js delete mode 100644 docs/assets/js/122.9d807a94.js delete mode 100644 docs/assets/js/123.2a822b35.js delete mode 100644 docs/assets/js/124.4e7f4672.js delete mode 100644 docs/assets/js/125.2e967439.js delete mode 100644 docs/assets/js/126.2f75633a.js delete mode 100644 docs/assets/js/127.6a1e1746.js delete mode 100644 docs/assets/js/128.7cff7178.js delete mode 100644 docs/assets/js/129.ea33f5cb.js delete mode 100644 docs/assets/js/13.89e4dbaf.js delete mode 100644 docs/assets/js/130.3c5e03a1.js delete mode 100644 docs/assets/js/131.dcf81ac8.js delete mode 100644 docs/assets/js/132.cfdf6b8f.js delete mode 100644 docs/assets/js/133.1a7accd7.js delete mode 100644 docs/assets/js/134.402b574e.js delete mode 100644 docs/assets/js/135.7dd6b4db.js delete mode 100644 docs/assets/js/136.9dcd2366.js delete mode 100644 docs/assets/js/137.cdee1656.js delete mode 100644 docs/assets/js/138.39184086.js delete mode 100644 docs/assets/js/139.f90df65f.js delete mode 100644 docs/assets/js/14.8212f44f.js delete mode 100644 docs/assets/js/140.df0fdbee.js delete mode 100644 docs/assets/js/141.3ac35658.js delete mode 100644 docs/assets/js/142.b2cceeea.js delete mode 100644 docs/assets/js/143.580c8451.js delete mode 100644 docs/assets/js/144.68e753bb.js delete mode 100644 docs/assets/js/145.340cc950.js delete mode 100644 docs/assets/js/146.cf86a887.js delete mode 100644 docs/assets/js/147.e8467d58.js delete mode 100644 docs/assets/js/148.d62977b0.js delete mode 100644 docs/assets/js/149.4423ac17.js delete mode 100644 docs/assets/js/15.d8a6af32.js delete mode 100644 docs/assets/js/150.27c79c1e.js delete mode 100644 docs/assets/js/151.f45a01cd.js delete mode 100644 docs/assets/js/152.9e0ddfd2.js delete mode 100644 docs/assets/js/153.dd79521c.js delete mode 100644 docs/assets/js/154.d684ed56.js delete mode 100644 docs/assets/js/155.132e736b.js delete mode 100644 docs/assets/js/156.7375610d.js delete mode 100644 docs/assets/js/157.3015cd77.js delete mode 100644 docs/assets/js/158.3fdd4c6d.js delete mode 100644 docs/assets/js/159.3879d14f.js delete mode 100644 docs/assets/js/16.40151e05.js delete mode 100644 docs/assets/js/160.2187440a.js delete mode 100644 docs/assets/js/161.680a3a2c.js delete mode 100644 docs/assets/js/162.0715e720.js delete mode 100644 docs/assets/js/163.13f3ff17.js delete mode 100644 docs/assets/js/164.729efdb3.js delete mode 100644 docs/assets/js/165.d4599569.js delete mode 100644 docs/assets/js/166.1d7b1fd8.js delete mode 100644 docs/assets/js/167.67c476d6.js delete mode 100644 docs/assets/js/168.1a2681d6.js delete mode 100644 docs/assets/js/169.6f182405.js delete mode 100644 docs/assets/js/17.0cadbbe1.js delete mode 100644 docs/assets/js/170.e5a9cf81.js delete mode 100644 docs/assets/js/171.0fa7c9d5.js delete mode 100644 docs/assets/js/172.ea468e02.js delete mode 100644 docs/assets/js/173.0b544598.js delete mode 100644 docs/assets/js/174.9ab8554e.js delete mode 100644 docs/assets/js/175.9c2273db.js delete mode 100644 docs/assets/js/176.c8ca0f49.js delete mode 100644 docs/assets/js/177.5fa49e5c.js delete mode 100644 docs/assets/js/178.85753470.js delete mode 100644 docs/assets/js/179.33c19c3b.js delete mode 100644 docs/assets/js/18.714d6145.js delete mode 100644 docs/assets/js/180.f41fbd45.js delete mode 100644 docs/assets/js/181.3cbec004.js delete mode 100644 docs/assets/js/182.be73a590.js delete mode 100644 docs/assets/js/183.97ea8694.js delete mode 100644 docs/assets/js/184.f5c4d39a.js delete mode 100644 docs/assets/js/185.63a044a8.js delete mode 100644 docs/assets/js/186.edf6b277.js delete mode 100644 docs/assets/js/187.5c94433e.js delete mode 100644 docs/assets/js/188.7c0aa44e.js delete mode 100644 docs/assets/js/189.21bc2a5f.js delete mode 100644 docs/assets/js/19.ea56dec0.js delete mode 100644 docs/assets/js/190.58531b65.js delete mode 100644 docs/assets/js/191.1c94ebe3.js delete mode 100644 docs/assets/js/192.91f2c9a1.js delete mode 100644 docs/assets/js/193.917b4055.js delete mode 100644 docs/assets/js/194.ae691468.js delete mode 100644 docs/assets/js/195.a6b48df0.js delete mode 100644 docs/assets/js/196.87f89edc.js delete mode 100644 docs/assets/js/197.c36f7ea4.js delete mode 100644 docs/assets/js/198.525a4b7d.js delete mode 100644 docs/assets/js/199.5015f2d3.js delete mode 100644 docs/assets/js/2.16c7e4af.js delete mode 100644 docs/assets/js/20.0e054b48.js delete mode 100644 docs/assets/js/200.75faeee9.js delete mode 100644 docs/assets/js/201.44b6271a.js delete mode 100644 docs/assets/js/202.dfcfe327.js delete mode 100644 docs/assets/js/203.398e2047.js delete mode 100644 docs/assets/js/204.d9b4f519.js delete mode 100644 docs/assets/js/205.2657056f.js delete mode 100644 docs/assets/js/206.e65453db.js delete mode 100644 docs/assets/js/207.4de69828.js delete mode 100644 docs/assets/js/208.984d51cb.js delete mode 100644 docs/assets/js/209.643919d7.js delete mode 100644 docs/assets/js/21.60f7dc48.js delete mode 100644 docs/assets/js/210.b211216d.js delete mode 100644 docs/assets/js/211.1efecaad.js delete mode 100644 docs/assets/js/212.5126bb85.js delete mode 100644 docs/assets/js/213.cf3debe0.js delete mode 100644 docs/assets/js/214.a852db4b.js delete mode 100644 docs/assets/js/215.958e2264.js delete mode 100644 docs/assets/js/216.96259efd.js delete mode 100644 docs/assets/js/217.814d497f.js delete mode 100644 docs/assets/js/218.2b543c38.js delete mode 100644 docs/assets/js/219.cac05f6f.js delete mode 100644 docs/assets/js/22.a7728bb5.js delete mode 100644 docs/assets/js/220.ba0f1b57.js delete mode 100644 docs/assets/js/221.69960261.js delete mode 100644 docs/assets/js/222.16028c06.js delete mode 100644 docs/assets/js/223.e16c683c.js delete mode 100644 docs/assets/js/224.c038df2b.js delete mode 100644 docs/assets/js/225.7df2d9f2.js delete mode 100644 docs/assets/js/226.4c36f1be.js delete mode 100644 docs/assets/js/227.9a2401b9.js delete mode 100644 docs/assets/js/228.1b9fb659.js delete mode 100644 docs/assets/js/229.1e4a771a.js delete mode 100644 docs/assets/js/23.b30fdfff.js delete mode 100644 docs/assets/js/230.73c4c7fc.js delete mode 100644 docs/assets/js/231.e7c0d9a5.js delete mode 100644 docs/assets/js/232.5648aca5.js delete mode 100644 docs/assets/js/233.b647f4f0.js delete mode 100644 docs/assets/js/234.868104fc.js delete mode 100644 docs/assets/js/235.ecd00231.js delete mode 100644 docs/assets/js/236.ac517b92.js delete mode 100644 docs/assets/js/237.06cb3f91.js delete mode 100644 docs/assets/js/238.6cb64904.js delete mode 100644 docs/assets/js/239.63a6f16d.js delete mode 100644 docs/assets/js/24.0868fa0c.js delete mode 100644 docs/assets/js/240.c384fb29.js delete mode 100644 docs/assets/js/241.cf9360a5.js delete mode 100644 docs/assets/js/242.8ddb5516.js delete mode 100644 docs/assets/js/243.9ef77bc3.js delete mode 100644 docs/assets/js/244.0ccec493.js delete mode 100644 docs/assets/js/245.d2970f61.js delete mode 100644 docs/assets/js/246.964b56ca.js delete mode 100644 docs/assets/js/247.fe054aa5.js delete mode 100644 docs/assets/js/248.3616d6f4.js delete mode 100644 docs/assets/js/249.4b683772.js delete mode 100644 docs/assets/js/25.c9768e23.js delete mode 100644 docs/assets/js/250.73e40a70.js delete mode 100644 docs/assets/js/251.7558f2ea.js delete mode 100644 docs/assets/js/252.15f2dfec.js delete mode 100644 docs/assets/js/253.95cd7122.js delete mode 100644 docs/assets/js/254.b0b505a9.js delete mode 100644 docs/assets/js/255.cbeb6d0d.js delete mode 100644 docs/assets/js/256.aebda57b.js delete mode 100644 docs/assets/js/257.6c8ec712.js delete mode 100644 docs/assets/js/258.87f76ceb.js delete mode 100644 docs/assets/js/259.2e0368b6.js delete mode 100644 docs/assets/js/26.7808132a.js delete mode 100644 docs/assets/js/260.2248090b.js delete mode 100644 docs/assets/js/261.08c9df99.js delete mode 100644 docs/assets/js/262.3ff926a4.js delete mode 100644 docs/assets/js/263.45570ce9.js delete mode 100644 docs/assets/js/264.41f7177f.js delete mode 100644 docs/assets/js/265.a1c048fa.js delete mode 100644 docs/assets/js/266.3c3e4de7.js delete mode 100644 docs/assets/js/267.3098152d.js delete mode 100644 docs/assets/js/268.6741a34e.js delete mode 100644 docs/assets/js/269.1fd28d56.js delete mode 100644 docs/assets/js/27.fe4b5c14.js delete mode 100644 docs/assets/js/270.dcc22e3a.js delete mode 100644 docs/assets/js/271.3e4a008a.js delete mode 100644 docs/assets/js/272.8d20003e.js delete mode 100644 docs/assets/js/273.d3ba5b3e.js delete mode 100644 docs/assets/js/274.5faf4627.js delete mode 100644 docs/assets/js/275.6ce9fcd9.js delete mode 100644 docs/assets/js/276.086d7309.js delete mode 100644 docs/assets/js/277.136cb807.js delete mode 100644 docs/assets/js/278.9218f102.js delete mode 100644 docs/assets/js/279.293915b9.js delete mode 100644 docs/assets/js/28.83f8aa65.js delete mode 100644 docs/assets/js/280.7f0bf3fd.js delete mode 100644 docs/assets/js/281.e4381f47.js delete mode 100644 docs/assets/js/282.607fde22.js delete mode 100644 docs/assets/js/283.ac798380.js delete mode 100644 docs/assets/js/284.007fd642.js delete mode 100644 docs/assets/js/285.b84294e3.js delete mode 100644 docs/assets/js/286.c64351b3.js delete mode 100644 docs/assets/js/287.d27f6e11.js delete mode 100644 docs/assets/js/288.ac370bde.js delete mode 100644 docs/assets/js/289.e7d1422e.js delete mode 100644 docs/assets/js/29.47b5be8d.js delete mode 100644 docs/assets/js/290.0a031606.js delete mode 100644 docs/assets/js/291.8de8ff06.js delete mode 100644 docs/assets/js/292.bb0ea38c.js delete mode 100644 docs/assets/js/293.52eda1cd.js delete mode 100644 docs/assets/js/294.2cacd6cf.js delete mode 100644 docs/assets/js/295.7fe48d44.js delete mode 100644 docs/assets/js/296.f61c2c00.js delete mode 100644 docs/assets/js/297.c1127367.js delete mode 100644 docs/assets/js/298.b924b2b9.js delete mode 100644 docs/assets/js/299.932c15ac.js delete mode 100644 docs/assets/js/3.04cf2d04.js delete mode 100644 docs/assets/js/30.a8182388.js delete mode 100644 docs/assets/js/300.d570b029.js delete mode 100644 docs/assets/js/301.019d11c7.js delete mode 100644 docs/assets/js/302.c611b601.js delete mode 100644 docs/assets/js/303.a376d327.js delete mode 100644 docs/assets/js/304.5f0cff90.js delete mode 100644 docs/assets/js/305.63e74ee3.js delete mode 100644 docs/assets/js/306.cca22ee6.js delete mode 100644 docs/assets/js/307.c95b53d7.js delete mode 100644 docs/assets/js/308.5fda621d.js delete mode 100644 docs/assets/js/309.9b876058.js delete mode 100644 docs/assets/js/31.f46c7404.js delete mode 100644 docs/assets/js/310.419a700f.js delete mode 100644 docs/assets/js/311.f8af589d.js delete mode 100644 docs/assets/js/312.2450b227.js delete mode 100644 docs/assets/js/313.b9009865.js delete mode 100644 docs/assets/js/314.53a72f42.js delete mode 100644 docs/assets/js/315.984b43a5.js delete mode 100644 docs/assets/js/316.0c709a9e.js delete mode 100644 docs/assets/js/317.60e8df6c.js delete mode 100644 docs/assets/js/318.c630d384.js delete mode 100644 docs/assets/js/319.b2671ca4.js delete mode 100644 docs/assets/js/32.d1cfa31f.js delete mode 100644 docs/assets/js/320.afbbd029.js delete mode 100644 docs/assets/js/321.339d71c2.js delete mode 100644 docs/assets/js/322.e9f5bb56.js delete mode 100644 docs/assets/js/323.18234317.js delete mode 100644 docs/assets/js/324.876d6fa4.js delete mode 100644 docs/assets/js/325.760b9745.js delete mode 100644 docs/assets/js/326.6d4fa02d.js delete mode 100644 docs/assets/js/327.281fe456.js delete mode 100644 docs/assets/js/328.c5495c85.js delete mode 100644 docs/assets/js/329.ed360faa.js delete mode 100644 docs/assets/js/33.8a0e0669.js delete mode 100644 docs/assets/js/330.f19292df.js delete mode 100644 docs/assets/js/331.4c61687a.js delete mode 100644 docs/assets/js/332.a3d97398.js delete mode 100644 docs/assets/js/333.59e4acd9.js delete mode 100644 docs/assets/js/334.50b4fc9a.js delete mode 100644 docs/assets/js/335.8601cab4.js delete mode 100644 docs/assets/js/336.e5fe146e.js delete mode 100644 docs/assets/js/337.34dc215b.js delete mode 100644 docs/assets/js/338.e2dbfeee.js delete mode 100644 docs/assets/js/339.86dcca2a.js delete mode 100644 docs/assets/js/34.b504662f.js delete mode 100644 docs/assets/js/340.fb493bcb.js delete mode 100644 docs/assets/js/341.7793a420.js delete mode 100644 docs/assets/js/342.894cba5f.js delete mode 100644 docs/assets/js/343.808d0d4b.js delete mode 100644 docs/assets/js/344.c80cd4fa.js delete mode 100644 docs/assets/js/345.7c227d05.js delete mode 100644 docs/assets/js/346.b1f040e3.js delete mode 100644 docs/assets/js/347.b45f5f70.js delete mode 100644 docs/assets/js/348.111d9030.js delete mode 100644 docs/assets/js/349.beab680d.js delete mode 100644 docs/assets/js/35.7026463c.js delete mode 100644 docs/assets/js/350.dd8e26c9.js delete mode 100644 docs/assets/js/351.d5d29456.js delete mode 100644 docs/assets/js/352.4ca1680f.js delete mode 100644 docs/assets/js/353.a00d14f4.js delete mode 100644 docs/assets/js/354.f8abebf6.js delete mode 100644 docs/assets/js/355.7bf4ffd3.js delete mode 100644 docs/assets/js/356.8c59d551.js delete mode 100644 docs/assets/js/357.8b269634.js delete mode 100644 docs/assets/js/358.0d9fae89.js delete mode 100644 docs/assets/js/359.1864fd51.js delete mode 100644 docs/assets/js/36.83308d7e.js delete mode 100644 docs/assets/js/360.995c1f87.js delete mode 100644 docs/assets/js/361.07f86df7.js delete mode 100644 docs/assets/js/362.2377269e.js delete mode 100644 docs/assets/js/363.a7e04d3f.js delete mode 100644 docs/assets/js/364.3a087e99.js delete mode 100644 docs/assets/js/365.7e7081ca.js delete mode 100644 docs/assets/js/366.d6ed06a5.js delete mode 100644 docs/assets/js/367.1ed3b875.js delete mode 100644 docs/assets/js/368.2726ec3d.js delete mode 100644 docs/assets/js/369.be7a251d.js delete mode 100644 docs/assets/js/37.1b12964f.js delete mode 100644 docs/assets/js/370.d728c50e.js delete mode 100644 docs/assets/js/371.1221fd08.js delete mode 100644 docs/assets/js/372.ed7d2826.js delete mode 100644 docs/assets/js/373.3a75111b.js delete mode 100644 docs/assets/js/374.e62cbb4c.js delete mode 100644 docs/assets/js/375.91881f5b.js delete mode 100644 docs/assets/js/376.1db690d5.js delete mode 100644 docs/assets/js/377.de5d9945.js delete mode 100644 docs/assets/js/378.66e8da8f.js delete mode 100644 docs/assets/js/379.a33060cc.js delete mode 100644 docs/assets/js/38.6e2028aa.js delete mode 100644 docs/assets/js/380.b99b07cb.js delete mode 100644 docs/assets/js/381.ecdccf3b.js delete mode 100644 docs/assets/js/382.74ce6934.js delete mode 100644 docs/assets/js/383.b2df99e3.js delete mode 100644 docs/assets/js/384.3340f275.js delete mode 100644 docs/assets/js/385.d812add9.js delete mode 100644 docs/assets/js/386.88818459.js delete mode 100644 docs/assets/js/387.6ca2ea8e.js delete mode 100644 docs/assets/js/388.2a85b4d3.js delete mode 100644 docs/assets/js/389.32e60d49.js delete mode 100644 docs/assets/js/39.2ef37369.js delete mode 100644 docs/assets/js/390.bf318495.js delete mode 100644 docs/assets/js/391.93d6b009.js delete mode 100644 docs/assets/js/392.5b3ed9eb.js delete mode 100644 docs/assets/js/393.129cca6c.js delete mode 100644 docs/assets/js/394.e51c5ace.js delete mode 100644 docs/assets/js/395.f2f04b18.js delete mode 100644 docs/assets/js/396.1fd42ede.js delete mode 100644 docs/assets/js/397.c1813965.js delete mode 100644 docs/assets/js/398.32eb13aa.js delete mode 100644 docs/assets/js/399.795446a3.js delete mode 100644 docs/assets/js/4.adbf2d29.js delete mode 100644 docs/assets/js/40.49c833ce.js delete mode 100644 docs/assets/js/400.f6ece95d.js delete mode 100644 docs/assets/js/401.0002d8cf.js delete mode 100644 docs/assets/js/402.dd239bd6.js delete mode 100644 docs/assets/js/403.162a25a1.js delete mode 100644 docs/assets/js/404.cd26d08b.js delete mode 100644 docs/assets/js/405.41d2d800.js delete mode 100644 docs/assets/js/406.b4c405ad.js delete mode 100644 docs/assets/js/407.1482cae8.js delete mode 100644 docs/assets/js/408.b826a189.js delete mode 100644 docs/assets/js/409.be518933.js delete mode 100644 docs/assets/js/41.0e6ea377.js delete mode 100644 docs/assets/js/410.86fff13b.js delete mode 100644 docs/assets/js/411.6c670c0f.js delete mode 100644 docs/assets/js/412.8092ef28.js delete mode 100644 docs/assets/js/413.19be8b54.js delete mode 100644 docs/assets/js/414.76493004.js delete mode 100644 docs/assets/js/415.bdff2d2d.js delete mode 100644 docs/assets/js/416.889eb219.js delete mode 100644 docs/assets/js/417.534b13ab.js delete mode 100644 docs/assets/js/418.d43b51b8.js delete mode 100644 docs/assets/js/419.e38eec68.js delete mode 100644 docs/assets/js/42.8407b7c4.js delete mode 100644 docs/assets/js/420.bf13b289.js delete mode 100644 docs/assets/js/421.616046f6.js delete mode 100644 docs/assets/js/422.3933effc.js delete mode 100644 docs/assets/js/423.21e1d41f.js delete mode 100644 docs/assets/js/424.c7c086b6.js delete mode 100644 docs/assets/js/425.54913cd2.js delete mode 100644 docs/assets/js/426.a7fed113.js delete mode 100644 docs/assets/js/427.7f371c22.js delete mode 100644 docs/assets/js/428.08745b54.js delete mode 100644 docs/assets/js/429.d20bd9c7.js delete mode 100644 docs/assets/js/43.5f2da7c0.js delete mode 100644 docs/assets/js/430.f2cbef53.js delete mode 100644 docs/assets/js/431.42063ff2.js delete mode 100644 docs/assets/js/432.b47603bf.js delete mode 100644 docs/assets/js/433.4f152866.js delete mode 100644 docs/assets/js/434.cd85ac32.js delete mode 100644 docs/assets/js/435.55e8c3a4.js delete mode 100644 docs/assets/js/436.b77a1376.js delete mode 100644 docs/assets/js/437.69537313.js delete mode 100644 docs/assets/js/438.6258626a.js delete mode 100644 docs/assets/js/439.233d0a88.js delete mode 100644 docs/assets/js/44.8aeba118.js delete mode 100644 docs/assets/js/440.ddb31beb.js delete mode 100644 docs/assets/js/441.4822f02c.js delete mode 100644 docs/assets/js/442.b941fe1e.js delete mode 100644 docs/assets/js/443.4cf74cfd.js delete mode 100644 docs/assets/js/444.c39a1007.js delete mode 100644 docs/assets/js/445.03050f12.js delete mode 100644 docs/assets/js/446.889f7a8c.js delete mode 100644 docs/assets/js/447.2ec94099.js delete mode 100644 docs/assets/js/448.162c943f.js delete mode 100644 docs/assets/js/449.9d0db40b.js delete mode 100644 docs/assets/js/45.c2214929.js delete mode 100644 docs/assets/js/450.5083ce7e.js delete mode 100644 docs/assets/js/451.11fca1f7.js delete mode 100644 docs/assets/js/452.5d4a004c.js delete mode 100644 docs/assets/js/453.a8206442.js delete mode 100644 docs/assets/js/454.3040d79f.js delete mode 100644 docs/assets/js/455.e3040085.js delete mode 100644 docs/assets/js/456.4e7ac5cc.js delete mode 100644 docs/assets/js/457.99bd9def.js delete mode 100644 docs/assets/js/458.135f5897.js delete mode 100644 docs/assets/js/459.65aeb544.js delete mode 100644 docs/assets/js/46.94e69ce6.js delete mode 100644 docs/assets/js/460.46c9c6c5.js delete mode 100644 docs/assets/js/47.f9256cd5.js delete mode 100644 docs/assets/js/48.38486aa1.js delete mode 100644 docs/assets/js/49.9d343381.js delete mode 100644 docs/assets/js/5.45a9bb87.js delete mode 100644 docs/assets/js/50.5fe10ce8.js delete mode 100644 docs/assets/js/51.02b977ea.js delete mode 100644 docs/assets/js/52.55f294e3.js delete mode 100644 docs/assets/js/53.49b9b3f7.js delete mode 100644 docs/assets/js/54.4b6f6495.js delete mode 100644 docs/assets/js/55.0768babe.js delete mode 100644 docs/assets/js/56.a6db3bce.js delete mode 100644 docs/assets/js/57.8437eb37.js delete mode 100644 docs/assets/js/58.fa6e99dd.js delete mode 100644 docs/assets/js/59.09d0c438.js delete mode 100644 docs/assets/js/6.faddde38.js delete mode 100644 docs/assets/js/60.873c4917.js delete mode 100644 docs/assets/js/61.18b20d40.js delete mode 100644 docs/assets/js/62.5e5f1d72.js delete mode 100644 docs/assets/js/63.2de916c2.js delete mode 100644 docs/assets/js/64.afd165df.js delete mode 100644 docs/assets/js/65.ee2bfa33.js delete mode 100644 docs/assets/js/66.9c6a9f66.js delete mode 100644 docs/assets/js/67.ff49dc36.js delete mode 100644 docs/assets/js/68.1de2396b.js delete mode 100644 docs/assets/js/69.9e892d0b.js delete mode 100644 docs/assets/js/7.7d20a020.js delete mode 100644 docs/assets/js/70.0fa5cf88.js delete mode 100644 docs/assets/js/71.906dbe9f.js delete mode 100644 docs/assets/js/72.77fd6d42.js delete mode 100644 docs/assets/js/73.efcf09f8.js delete mode 100644 docs/assets/js/74.22a477fd.js delete mode 100644 docs/assets/js/75.9e613539.js delete mode 100644 docs/assets/js/76.fc057215.js delete mode 100644 docs/assets/js/77.d2c78482.js delete mode 100644 docs/assets/js/78.51114efa.js delete mode 100644 docs/assets/js/79.d40e5274.js delete mode 100644 docs/assets/js/8.91aa366b.js delete mode 100644 docs/assets/js/80.947f0d3e.js delete mode 100644 docs/assets/js/81.e243d073.js delete mode 100644 docs/assets/js/82.95e1e9ef.js delete mode 100644 docs/assets/js/83.78169173.js delete mode 100644 docs/assets/js/84.4a6dfa97.js delete mode 100644 docs/assets/js/85.531e272e.js delete mode 100644 docs/assets/js/86.b95e8133.js delete mode 100644 docs/assets/js/87.d8fdeb9d.js delete mode 100644 docs/assets/js/88.18d0ae4f.js delete mode 100644 docs/assets/js/89.0611fea1.js delete mode 100644 docs/assets/js/9.a28c3096.js delete mode 100644 docs/assets/js/90.0eda8f57.js delete mode 100644 docs/assets/js/91.8bbc3dd9.js delete mode 100644 docs/assets/js/92.f2a6b3f4.js delete mode 100644 docs/assets/js/93.d506ddb5.js delete mode 100644 docs/assets/js/94.22bb7e14.js delete mode 100644 docs/assets/js/95.6985ab8e.js delete mode 100644 docs/assets/js/96.2378ec2d.js delete mode 100644 docs/assets/js/97.1402a4d4.js delete mode 100644 docs/assets/js/98.e668802c.js delete mode 100644 docs/assets/js/99.6746c5ca.js delete mode 100644 docs/assets/js/app.ea488efd.js delete mode 100644 docs/examples/promise/01_simple_connect/index.html delete mode 100644 docs/examples/promise/02_listen_to_blocks/index.html delete mode 100644 docs/examples/promise/03_listen_to_balance_change/index.html delete mode 100644 docs/examples/promise/04_unsubscribe/index.html delete mode 100644 docs/examples/promise/05_read_storage/index.html delete mode 100644 docs/examples/promise/06_make_transfer/index.html delete mode 100644 docs/examples/promise/08_system_events/index.html delete mode 100644 docs/examples/promise/09_transfer_events/index.html delete mode 100644 docs/examples/promise/10_upgrade_chain/index.html delete mode 100644 docs/examples/promise/index.html delete mode 100644 docs/examples/rx/01_simple_connect/index.html delete mode 100644 docs/examples/rx/02_listen_to_blocks/index.html delete mode 100644 docs/examples/rx/03_listen_to_balance_change/index.html delete mode 100644 docs/examples/rx/04_unsubscribe/index.html delete mode 100644 docs/examples/rx/05_read_storage/index.html delete mode 100644 docs/examples/rx/06_make_transfer/index.html delete mode 100644 docs/examples/rx/08_system_events/index.html delete mode 100644 docs/examples/rx/09_transfer_events/index.html delete mode 100644 docs/examples/rx/10_upgrade_chain/index.html delete mode 100644 docs/examples/rx/index.html delete mode 100644 docs/index.html delete mode 100644 docs/rpc-core/README.md delete mode 100644 docs/rpc-core/SUMMARY.html delete mode 100644 docs/rpc-core/SUMMARY.md delete mode 100644 docs/rpc-core/index.html delete mode 100644 docs/rpc-core/interfaces/_types_.rpcinterface.html delete mode 100644 docs/rpc-core/interfaces/_types_.rpcinterface.md delete mode 100644 docs/rpc-core/interfaces/_types_.rpcinterface_method.html delete mode 100644 docs/rpc-core/interfaces/_types_.rpcinterface_method.md delete mode 100644 docs/rpc-core/modules/_types_.html delete mode 100644 docs/rpc-core/modules/_types_.md delete mode 100644 docs/rpc-provider/README.md delete mode 100644 docs/rpc-provider/SUMMARY.html delete mode 100644 docs/rpc-provider/SUMMARY.md delete mode 100644 docs/rpc-provider/classes/_ws_provider_.wsprovider.html delete mode 100644 docs/rpc-provider/classes/_ws_provider_.wsprovider.md delete mode 100644 docs/rpc-provider/index.html delete mode 100644 docs/rpc-provider/interfaces/_types_.providerinterface.html delete mode 100644 docs/rpc-provider/interfaces/_types_.providerinterface.md delete mode 100644 docs/rpc-provider/modules/_defaults_.html delete mode 100644 docs/rpc-provider/modules/_defaults_.md delete mode 100644 docs/rpc-provider/modules/_http_polyfill_.html delete mode 100644 docs/rpc-provider/modules/_http_polyfill_.md delete mode 100644 docs/rpc-provider/modules/_http_types_.html delete mode 100644 docs/rpc-provider/modules/_http_types_.md delete mode 100644 docs/rpc-provider/modules/_mock_types_.html delete mode 100644 docs/rpc-provider/modules/_mock_types_.md delete mode 100644 docs/rpc-provider/modules/_types_.html delete mode 100644 docs/rpc-provider/modules/_types_.md delete mode 100644 docs/rpc-provider/modules/_ws_polyfill_.html delete mode 100644 docs/rpc-provider/modules/_ws_polyfill_.md delete mode 100644 docs/rpc-provider/modules/_ws_provider_.html delete mode 100644 docs/rpc-provider/modules/_ws_provider_.md delete mode 100644 docs/rpc-rx/README.md delete mode 100644 docs/rpc-rx/SUMMARY.html delete mode 100644 docs/rpc-rx/SUMMARY.md delete mode 100644 docs/rpc-rx/index.html delete mode 100644 docs/rpc-rx/modules/_types_.html delete mode 100644 docs/rpc-rx/modules/_types_.md delete mode 100644 docs/type-extrinsics/README.md delete mode 100644 docs/type-extrinsics/SUMMARY.html delete mode 100644 docs/type-extrinsics/SUMMARY.md delete mode 100644 docs/type-extrinsics/index.html delete mode 100644 docs/type-extrinsics/modules/_frommetadata_.html delete mode 100644 docs/type-extrinsics/modules/_frommetadata_.md delete mode 100644 docs/type-extrinsics/modules/_static_.html delete mode 100644 docs/type-extrinsics/modules/_static_.md delete mode 100644 docs/type-extrinsics/modules/_utils_createunchecked_.html delete mode 100644 docs/type-extrinsics/modules/_utils_createunchecked_.md delete mode 100644 docs/type-jsonrpc/README.md delete mode 100644 docs/type-jsonrpc/SUMMARY.html delete mode 100644 docs/type-jsonrpc/SUMMARY.md delete mode 100644 docs/type-jsonrpc/index.html delete mode 100644 docs/type-jsonrpc/modules/_author_.html delete mode 100644 docs/type-jsonrpc/modules/_author_.md delete mode 100644 docs/type-jsonrpc/modules/_chain_.html delete mode 100644 docs/type-jsonrpc/modules/_chain_.md delete mode 100644 docs/type-jsonrpc/modules/_create_method_.html delete mode 100644 docs/type-jsonrpc/modules/_create_method_.md delete mode 100644 docs/type-jsonrpc/modules/_create_param_.html delete mode 100644 docs/type-jsonrpc/modules/_create_param_.md delete mode 100644 docs/type-jsonrpc/modules/_state_.html delete mode 100644 docs/type-jsonrpc/modules/_state_.md delete mode 100644 docs/type-jsonrpc/modules/_system_.html delete mode 100644 docs/type-jsonrpc/modules/_system_.md delete mode 100644 docs/type-jsonrpc/modules/_types_.html delete mode 100644 docs/type-jsonrpc/modules/_types_.md delete mode 100644 docs/type-storage/README.md delete mode 100644 docs/type-storage/SUMMARY.html delete mode 100644 docs/type-storage/SUMMARY.md delete mode 100644 docs/type-storage/index.html delete mode 100644 docs/type-storage/interfaces/_types_.modulestorage.html delete mode 100644 docs/type-storage/interfaces/_types_.modulestorage.md delete mode 100644 docs/type-storage/interfaces/_types_.storage.html delete mode 100644 docs/type-storage/interfaces/_types_.storage.md delete mode 100644 docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.html delete mode 100644 docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md delete mode 100644 docs/type-storage/modules/_frommetadata_.html delete mode 100644 docs/type-storage/modules/_frommetadata_.md delete mode 100644 docs/type-storage/modules/_static_.html delete mode 100644 docs/type-storage/modules/_static_.md delete mode 100644 docs/type-storage/modules/_storage_.html delete mode 100644 docs/type-storage/modules/_storage_.md delete mode 100644 docs/type-storage/modules/_substrate_.html delete mode 100644 docs/type-storage/modules/_substrate_.md delete mode 100644 docs/type-storage/modules/_types_.html delete mode 100644 docs/type-storage/modules/_types_.md delete mode 100644 docs/type-storage/modules/_utils_createfunction_.html delete mode 100644 docs/type-storage/modules/_utils_createfunction_.md delete mode 100644 docs/types/README.md delete mode 100644 docs/types/SUMMARY.html delete mode 100644 docs/types/SUMMARY.md delete mode 100644 docs/types/classes/_codec_base_.base.html delete mode 100644 docs/types/classes/_codec_base_.base.md delete mode 100644 docs/types/classes/_codec_compact_.compact.html delete mode 100644 docs/types/classes/_codec_compact_.compact.md delete mode 100644 docs/types/classes/_codec_enum_.enum.html delete mode 100644 docs/types/classes/_codec_enum_.enum.md delete mode 100644 docs/types/classes/_codec_enumtype_.enumtype.html delete mode 100644 docs/types/classes/_codec_enumtype_.enumtype.md delete mode 100644 docs/types/classes/_codec_int_.int.html delete mode 100644 docs/types/classes/_codec_int_.int.md delete mode 100644 docs/types/classes/_codec_option_.option.html delete mode 100644 docs/types/classes/_codec_option_.option.md delete mode 100644 docs/types/classes/_codec_set_.set.html delete mode 100644 docs/types/classes/_codec_set_.set.md delete mode 100644 docs/types/classes/_codec_struct_.struct.html delete mode 100644 docs/types/classes/_codec_struct_.struct.md delete mode 100644 docs/types/classes/_codec_tuple_.tuple.html delete mode 100644 docs/types/classes/_codec_tuple_.tuple.md delete mode 100644 docs/types/classes/_codec_typeregistry_.typeregistry.html delete mode 100644 docs/types/classes/_codec_typeregistry_.typeregistry.md delete mode 100644 docs/types/classes/_codec_u8a_.u8a.html delete mode 100644 docs/types/classes/_codec_u8a_.u8a.md delete mode 100644 docs/types/classes/_codec_u8afixed_.u8afixed.html delete mode 100644 docs/types/classes/_codec_u8afixed_.u8afixed.md delete mode 100644 docs/types/classes/_codec_uint_.uint.html delete mode 100644 docs/types/classes/_codec_uint_.uint.md delete mode 100644 docs/types/classes/_codec_vector_.vector.html delete mode 100644 docs/types/classes/_codec_vector_.vector.md delete mode 100644 docs/types/classes/_metadata_magicnumber_.magicnumber.html delete mode 100644 docs/types/classes/_metadata_magicnumber_.magicnumber.md delete mode 100644 docs/types/classes/_metadata_metadata_.metadata.html delete mode 100644 docs/types/classes/_metadata_metadata_.metadata.md delete mode 100644 docs/types/classes/_metadata_metadataversioned_.metadataversioned.html delete mode 100644 docs/types/classes/_metadata_metadataversioned_.metadataversioned.md delete mode 100644 docs/types/classes/_metadata_v0_calls_.outerdispatchcall.html delete mode 100644 docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md delete mode 100644 docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html delete mode 100644 docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md delete mode 100644 docs/types/classes/_metadata_v0_events_.eventmetadata.html delete mode 100644 docs/types/classes/_metadata_v0_events_.eventmetadata.md delete mode 100644 docs/types/classes/_metadata_v0_events_.outereventmetadata.html delete mode 100644 docs/types/classes/_metadata_v0_events_.outereventmetadata.md delete mode 100644 docs/types/classes/_metadata_v0_events_.outereventmetadataevent.html delete mode 100644 docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md delete mode 100644 docs/types/classes/_metadata_v0_metadata_.metadatav0.html delete mode 100644 docs/types/classes/_metadata_v0_metadata_.metadatav0.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.callmetadata.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.callmetadata.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.functionmetadata.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.functionmetadata.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.maptype.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.maptype.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.modulemetadata.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.modulemetadata.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagefunctiontype.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagemetadata.html delete mode 100644 docs/types/classes/_metadata_v0_modules_.storagemetadata.md delete mode 100644 docs/types/classes/_metadata_v1_calls_.metadatacall.html delete mode 100644 docs/types/classes/_metadata_v1_calls_.metadatacall.md delete mode 100644 docs/types/classes/_metadata_v1_calls_.metadatacallarg.html delete mode 100644 docs/types/classes/_metadata_v1_calls_.metadatacallarg.md delete mode 100644 docs/types/classes/_metadata_v1_events_.metadataevent.html delete mode 100644 docs/types/classes/_metadata_v1_events_.metadataevent.md delete mode 100644 docs/types/classes/_metadata_v1_metadata_.metadatamodule.html delete mode 100644 docs/types/classes/_metadata_v1_metadata_.metadatamodule.md delete mode 100644 docs/types/classes/_metadata_v1_metadata_.metadatav1.html delete mode 100644 docs/types/classes/_metadata_v1_metadata_.metadatav1.md delete mode 100644 docs/types/classes/_metadata_v1_storage_.default.html delete mode 100644 docs/types/classes/_metadata_v1_storage_.default.md delete mode 100644 docs/types/classes/_metadata_v1_storage_.maptype.html delete mode 100644 docs/types/classes/_metadata_v1_storage_.maptype.md delete mode 100644 docs/types/classes/_metadata_v1_storage_.metadatastorage.html delete mode 100644 docs/types/classes/_metadata_v1_storage_.metadatastorage.md delete mode 100644 docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html delete mode 100644 docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md delete mode 100644 docs/types/classes/_metadata_v1_storage_.metadatastoragetype.html delete mode 100644 docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md delete mode 100644 docs/types/classes/_metadata_v1_storage_.optional.html delete mode 100644 docs/types/classes/_metadata_v1_storage_.optional.md delete mode 100644 docs/types/classes/_metadata_v1_storage_.plaintype.html delete mode 100644 docs/types/classes/_metadata_v1_storage_.plaintype.md delete mode 100644 docs/types/classes/_primitive_bool_.bool.html delete mode 100644 docs/types/classes/_primitive_bool_.bool.md delete mode 100644 docs/types/classes/_primitive_bytes_.bytes.html delete mode 100644 docs/types/classes/_primitive_bytes_.bytes.md delete mode 100644 docs/types/classes/_primitive_data_.data.html delete mode 100644 docs/types/classes/_primitive_data_.data.md delete mode 100644 docs/types/classes/_primitive_h160_.h160.html delete mode 100644 docs/types/classes/_primitive_h160_.h160.md delete mode 100644 docs/types/classes/_primitive_h256_.h256.html delete mode 100644 docs/types/classes/_primitive_h256_.h256.md delete mode 100644 docs/types/classes/_primitive_h512_.h512.html delete mode 100644 docs/types/classes/_primitive_h512_.h512.md delete mode 100644 docs/types/classes/_primitive_i128_.i128.html delete mode 100644 docs/types/classes/_primitive_i128_.i128.md delete mode 100644 docs/types/classes/_primitive_i16_.i16.html delete mode 100644 docs/types/classes/_primitive_i16_.i16.md delete mode 100644 docs/types/classes/_primitive_i256_.i256.html delete mode 100644 docs/types/classes/_primitive_i256_.i256.md delete mode 100644 docs/types/classes/_primitive_i32_.i32.html delete mode 100644 docs/types/classes/_primitive_i32_.i32.md delete mode 100644 docs/types/classes/_primitive_i64_.i64.html delete mode 100644 docs/types/classes/_primitive_i64_.i64.md delete mode 100644 docs/types/classes/_primitive_i8_.i8.html delete mode 100644 docs/types/classes/_primitive_i8_.i8.md delete mode 100644 docs/types/classes/_primitive_method_.method.html delete mode 100644 docs/types/classes/_primitive_method_.method.md delete mode 100644 docs/types/classes/_primitive_method_.methodindex.html delete mode 100644 docs/types/classes/_primitive_method_.methodindex.md delete mode 100644 docs/types/classes/_primitive_moment_.moment.html delete mode 100644 docs/types/classes/_primitive_moment_.moment.md delete mode 100644 docs/types/classes/_primitive_moment_.momentof.html delete mode 100644 docs/types/classes/_primitive_moment_.momentof.md delete mode 100644 docs/types/classes/_primitive_null_.null.html delete mode 100644 docs/types/classes/_primitive_null_.null.md delete mode 100644 docs/types/classes/_primitive_storagedata_.storagedata.html delete mode 100644 docs/types/classes/_primitive_storagedata_.storagedata.md delete mode 100644 docs/types/classes/_primitive_storagekey_.storagekey.html delete mode 100644 docs/types/classes/_primitive_storagekey_.storagekey.md delete mode 100644 docs/types/classes/_primitive_text_.text.html delete mode 100644 docs/types/classes/_primitive_text_.text.md delete mode 100644 docs/types/classes/_primitive_type_.type.html delete mode 100644 docs/types/classes/_primitive_type_.type.md delete mode 100644 docs/types/classes/_primitive_u128_.u128.html delete mode 100644 docs/types/classes/_primitive_u128_.u128.md delete mode 100644 docs/types/classes/_primitive_u16_.u16.html delete mode 100644 docs/types/classes/_primitive_u16_.u16.md delete mode 100644 docs/types/classes/_primitive_u256_.u256.html delete mode 100644 docs/types/classes/_primitive_u256_.u256.md delete mode 100644 docs/types/classes/_primitive_u32_.u32.html delete mode 100644 docs/types/classes/_primitive_u32_.u32.md delete mode 100644 docs/types/classes/_primitive_u64_.u64.html delete mode 100644 docs/types/classes/_primitive_u64_.u64.md delete mode 100644 docs/types/classes/_primitive_u8_.u8.html delete mode 100644 docs/types/classes/_primitive_u8_.u8.md delete mode 100644 docs/types/classes/_primitive_usize_.usize.html delete mode 100644 docs/types/classes/_primitive_usize_.usize.md delete mode 100644 docs/types/classes/_rpc_chainproperties_.chainproperties.html delete mode 100644 docs/types/classes/_rpc_chainproperties_.chainproperties.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.broadcast.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.broadcast.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.dropped.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.dropped.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.finalised.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.finalised.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.future.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.future.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.invalid.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.invalid.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.ready.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.ready.md delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.usurped.html delete mode 100644 docs/types/classes/_rpc_extrinsicstatus_.usurped.md delete mode 100644 docs/types/classes/_rpc_health_.health.html delete mode 100644 docs/types/classes/_rpc_health_.health.md delete mode 100644 docs/types/classes/_rpc_json_.json.html delete mode 100644 docs/types/classes/_rpc_json_.json.md delete mode 100644 docs/types/classes/_rpc_networkstate_.networkstate.html delete mode 100644 docs/types/classes/_rpc_networkstate_.networkstate.md delete mode 100644 docs/types/classes/_rpc_peerinfo_.peerinfo.html delete mode 100644 docs/types/classes/_rpc_peerinfo_.peerinfo.md delete mode 100644 docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html delete mode 100644 docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.md delete mode 100644 docs/types/classes/_rpc_runtimeversion_.apiid.html delete mode 100644 docs/types/classes/_rpc_runtimeversion_.apiid.md delete mode 100644 docs/types/classes/_rpc_runtimeversion_.runtimeversion.html delete mode 100644 docs/types/classes/_rpc_runtimeversion_.runtimeversion.md delete mode 100644 docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.html delete mode 100644 docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.md delete mode 100644 docs/types/classes/_rpc_signedblock_.signedblock.html delete mode 100644 docs/types/classes/_rpc_signedblock_.signedblock.md delete mode 100644 docs/types/classes/_rpc_storagechangeset_.storagechangeset.html delete mode 100644 docs/types/classes/_rpc_storagechangeset_.storagechangeset.md delete mode 100644 docs/types/classes/_type_accountid_.accountid.html delete mode 100644 docs/types/classes/_type_accountid_.accountid.md delete mode 100644 docs/types/classes/_type_accountid_.accountidof.html delete mode 100644 docs/types/classes/_type_accountid_.accountidof.md delete mode 100644 docs/types/classes/_type_accountindex_.accountindex.html delete mode 100644 docs/types/classes/_type_accountindex_.accountindex.md delete mode 100644 docs/types/classes/_type_address_.address.html delete mode 100644 docs/types/classes/_type_address_.address.md delete mode 100644 docs/types/classes/_type_amount_.amount.html delete mode 100644 docs/types/classes/_type_amount_.amount.md delete mode 100644 docs/types/classes/_type_assetof_.assetof.html delete mode 100644 docs/types/classes/_type_assetof_.assetof.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.attestedcandidate.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.attestedcandidate.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.availabilityvote.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.availabilityvote.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.balanceupload.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.balanceupload.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.candidatereceipt.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.candidatereceipt.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.candidatesignature.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.candidatesignature.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.egressqueueroot.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.egressqueueroot.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.headdata.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.headdata.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.validityattestation.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.validityattestation.md delete mode 100644 docs/types/classes/_type_attestedcandidate_.validityvote.html delete mode 100644 docs/types/classes/_type_attestedcandidate_.validityvote.md delete mode 100644 docs/types/classes/_type_authorityid_.authorityid.html delete mode 100644 docs/types/classes/_type_authorityid_.authorityid.md delete mode 100644 docs/types/classes/_type_balance_.balance.html delete mode 100644 docs/types/classes/_type_balance_.balance.md delete mode 100644 docs/types/classes/_type_balance_.balanceof.html delete mode 100644 docs/types/classes/_type_balance_.balanceof.md delete mode 100644 docs/types/classes/_type_bft_.bftauthoritysignature.html delete mode 100644 docs/types/classes/_type_bft_.bftauthoritysignature.md delete mode 100644 docs/types/classes/_type_bft_.bfthashsignature.html delete mode 100644 docs/types/classes/_type_bft_.bfthashsignature.md delete mode 100644 docs/types/classes/_type_block_.block.html delete mode 100644 docs/types/classes/_type_block_.block.md delete mode 100644 docs/types/classes/_type_blocknumber_.blocknumber.html delete mode 100644 docs/types/classes/_type_blocknumber_.blocknumber.md delete mode 100644 docs/types/classes/_type_codehash_.codehash.html delete mode 100644 docs/types/classes/_type_codehash_.codehash.md delete mode 100644 docs/types/classes/_type_digest_.authoritieschange.html delete mode 100644 docs/types/classes/_type_digest_.authoritieschange.md delete mode 100644 docs/types/classes/_type_digest_.changestrieroot.html delete mode 100644 docs/types/classes/_type_digest_.changestrieroot.md delete mode 100644 docs/types/classes/_type_digest_.digest.html delete mode 100644 docs/types/classes/_type_digest_.digest.md delete mode 100644 docs/types/classes/_type_digest_.digestitem.html delete mode 100644 docs/types/classes/_type_digest_.digestitem.md delete mode 100644 docs/types/classes/_type_digest_.other.html delete mode 100644 docs/types/classes/_type_digest_.other.md delete mode 100644 docs/types/classes/_type_digest_.seal.html delete mode 100644 docs/types/classes/_type_digest_.seal.md delete mode 100644 docs/types/classes/_type_event_.event.html delete mode 100644 docs/types/classes/_type_event_.event.md delete mode 100644 docs/types/classes/_type_event_.eventdata.html delete mode 100644 docs/types/classes/_type_event_.eventdata.md delete mode 100644 docs/types/classes/_type_event_.eventindex.html delete mode 100644 docs/types/classes/_type_event_.eventindex.md delete mode 100644 docs/types/classes/_type_eventrecord_.applyextrinsic.html delete mode 100644 docs/types/classes/_type_eventrecord_.applyextrinsic.md delete mode 100644 docs/types/classes/_type_eventrecord_.eventrecord.html delete mode 100644 docs/types/classes/_type_eventrecord_.eventrecord.md delete mode 100644 docs/types/classes/_type_eventrecord_.finalization.html delete mode 100644 docs/types/classes/_type_eventrecord_.finalization.md delete mode 100644 docs/types/classes/_type_eventrecord_.phase.html delete mode 100644 docs/types/classes/_type_eventrecord_.phase.md delete mode 100644 docs/types/classes/_type_extrinsic_.extrinsic.html delete mode 100644 docs/types/classes/_type_extrinsic_.extrinsic.md delete mode 100644 docs/types/classes/_type_extrinsicera_.extrinsicera.html delete mode 100644 docs/types/classes/_type_extrinsicera_.extrinsicera.md delete mode 100644 docs/types/classes/_type_extrinsics_.extrinsics.html delete mode 100644 docs/types/classes/_type_extrinsics_.extrinsics.md delete mode 100644 docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.html delete mode 100644 docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md delete mode 100644 docs/types/classes/_type_gas_.gas.html delete mode 100644 docs/types/classes/_type_gas_.gas.md delete mode 100644 docs/types/classes/_type_hash_.hash.html delete mode 100644 docs/types/classes/_type_hash_.hash.md delete mode 100644 docs/types/classes/_type_header_.header.html delete mode 100644 docs/types/classes/_type_header_.header.md delete mode 100644 docs/types/classes/_type_header_.headerextended.html delete mode 100644 docs/types/classes/_type_header_.headerextended.md delete mode 100644 docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.html delete mode 100644 docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.md delete mode 100644 docs/types/classes/_type_justification_.justification.html delete mode 100644 docs/types/classes/_type_justification_.justification.md delete mode 100644 docs/types/classes/_type_justification_.rhdjustification.html delete mode 100644 docs/types/classes/_type_justification_.rhdjustification.md delete mode 100644 docs/types/classes/_type_keyvalue_.keyvalue.html delete mode 100644 docs/types/classes/_type_keyvalue_.keyvalue.md delete mode 100644 docs/types/classes/_type_keyvalue_.keyvalueoption.html delete mode 100644 docs/types/classes/_type_keyvalue_.keyvalueoption.md delete mode 100644 docs/types/classes/_type_lockperiods_.lockperiods.html delete mode 100644 docs/types/classes/_type_lockperiods_.lockperiods.md delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftatreport.html delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftatreport.md delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.html delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.html delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html delete mode 100644 docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md delete mode 100644 docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.html delete mode 100644 docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md delete mode 100644 docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.html delete mode 100644 docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md delete mode 100644 docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.html delete mode 100644 docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md delete mode 100644 docs/types/classes/_type_nonce_.nonce.html delete mode 100644 docs/types/classes/_type_nonce_.nonce.md delete mode 100644 docs/types/classes/_type_noncecompact_.noncecompact.html delete mode 100644 docs/types/classes/_type_noncecompact_.noncecompact.md delete mode 100644 docs/types/classes/_type_origin_.origin.html delete mode 100644 docs/types/classes/_type_origin_.origin.md delete mode 100644 docs/types/classes/_type_paraid_.paraid.html delete mode 100644 docs/types/classes/_type_paraid_.paraid.md delete mode 100644 docs/types/classes/_type_perbill_.perbill.html delete mode 100644 docs/types/classes/_type_perbill_.perbill.md delete mode 100644 docs/types/classes/_type_permill_.permill.html delete mode 100644 docs/types/classes/_type_permill_.permill.md delete mode 100644 docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html delete mode 100644 docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md delete mode 100644 docs/types/classes/_type_propindex_.propindex.html delete mode 100644 docs/types/classes/_type_propindex_.propindex.md delete mode 100644 docs/types/classes/_type_proposal_.proposal.html delete mode 100644 docs/types/classes/_type_proposal_.proposal.md delete mode 100644 docs/types/classes/_type_proposalindex_.proposalindex.html delete mode 100644 docs/types/classes/_type_proposalindex_.proposalindex.md delete mode 100644 docs/types/classes/_type_referendumindex_.referendumindex.html delete mode 100644 docs/types/classes/_type_referendumindex_.referendumindex.md delete mode 100644 docs/types/classes/_type_referenduminfo_.referenduminfo.html delete mode 100644 docs/types/classes/_type_referenduminfo_.referenduminfo.md delete mode 100644 docs/types/classes/_type_schedule_.schedule.html delete mode 100644 docs/types/classes/_type_schedule_.schedule.md delete mode 100644 docs/types/classes/_type_seedof_.seedof.html delete mode 100644 docs/types/classes/_type_seedof_.seedof.md delete mode 100644 docs/types/classes/_type_sessionkey_.sessionkey.html delete mode 100644 docs/types/classes/_type_sessionkey_.sessionkey.md delete mode 100644 docs/types/classes/_type_signature_.ed25519signature.html delete mode 100644 docs/types/classes/_type_signature_.ed25519signature.md delete mode 100644 docs/types/classes/_type_signature_.signature.html delete mode 100644 docs/types/classes/_type_signature_.signature.md delete mode 100644 docs/types/classes/_type_signature_.sr25519signature.html delete mode 100644 docs/types/classes/_type_signature_.sr25519signature.md delete mode 100644 docs/types/classes/_type_signaturepayload_.signaturepayload.html delete mode 100644 docs/types/classes/_type_signaturepayload_.signaturepayload.md delete mode 100644 docs/types/classes/_type_storedpendingchange_.nextauthority.html delete mode 100644 docs/types/classes/_type_storedpendingchange_.nextauthority.md delete mode 100644 docs/types/classes/_type_storedpendingchange_.storedpendingchange.html delete mode 100644 docs/types/classes/_type_storedpendingchange_.storedpendingchange.md delete mode 100644 docs/types/classes/_type_validatorprefs_.validatorprefs.html delete mode 100644 docs/types/classes/_type_validatorprefs_.validatorprefs.md delete mode 100644 docs/types/classes/_type_vestingschedule_.vestingschedule.html delete mode 100644 docs/types/classes/_type_vestingschedule_.vestingschedule.md delete mode 100644 docs/types/classes/_type_vote_.vote.html delete mode 100644 docs/types/classes/_type_vote_.vote.md delete mode 100644 docs/types/classes/_type_voteindex_.voteindex.html delete mode 100644 docs/types/classes/_type_voteindex_.voteindex.md delete mode 100644 docs/types/classes/_type_votethreshold_.votethreshold.html delete mode 100644 docs/types/classes/_type_votethreshold_.votethreshold.md delete mode 100644 docs/types/enums/_codec_createtype_.typedefinfo.html delete mode 100644 docs/types/enums/_codec_createtype_.typedefinfo.md delete mode 100644 docs/types/index.html delete mode 100644 docs/types/interfaces/_metadata_types_.metadatainterface.html delete mode 100644 docs/types/interfaces/_metadata_types_.metadatainterface.md delete mode 100644 docs/types/interfaces/_primitive_method_.methodfunction.html delete mode 100644 docs/types/interfaces/_primitive_method_.methodfunction.md delete mode 100644 docs/types/interfaces/_primitive_method_.methods.html delete mode 100644 docs/types/interfaces/_primitive_method_.methods.md delete mode 100644 docs/types/interfaces/_primitive_method_.moduleswithmethods.html delete mode 100644 docs/types/interfaces/_primitive_method_.moduleswithmethods.md delete mode 100644 docs/types/interfaces/_primitive_storagekey_.storagefunction.html delete mode 100644 docs/types/interfaces/_primitive_storagekey_.storagefunction.md delete mode 100644 docs/types/interfaces/_types_.codec.html delete mode 100644 docs/types/interfaces/_types_.codec.md delete mode 100644 docs/types/interfaces/_types_.constructor.html delete mode 100644 docs/types/interfaces/_types_.constructor.md delete mode 100644 docs/types/interfaces/_types_.runtimeversioninterface.html delete mode 100644 docs/types/interfaces/_types_.runtimeversioninterface.md delete mode 100644 docs/types/modules/_classes_.html delete mode 100644 docs/types/modules/_classes_.md delete mode 100644 docs/types/modules/_codec_abstractint_.html delete mode 100644 docs/types/modules/_codec_abstractint_.md delete mode 100644 docs/types/modules/_codec_base_.html delete mode 100644 docs/types/modules/_codec_base_.md delete mode 100644 docs/types/modules/_codec_compact_.html delete mode 100644 docs/types/modules/_codec_compact_.md delete mode 100644 docs/types/modules/_codec_createtype_.html delete mode 100644 docs/types/modules/_codec_createtype_.md delete mode 100644 docs/types/modules/_codec_enum_.html delete mode 100644 docs/types/modules/_codec_enum_.md delete mode 100644 docs/types/modules/_codec_enumtype_.html delete mode 100644 docs/types/modules/_codec_enumtype_.md delete mode 100644 docs/types/modules/_codec_int_.html delete mode 100644 docs/types/modules/_codec_int_.md delete mode 100644 docs/types/modules/_codec_option_.html delete mode 100644 docs/types/modules/_codec_option_.md delete mode 100644 docs/types/modules/_codec_set_.html delete mode 100644 docs/types/modules/_codec_set_.md delete mode 100644 docs/types/modules/_codec_struct_.html delete mode 100644 docs/types/modules/_codec_struct_.md delete mode 100644 docs/types/modules/_codec_tuple_.html delete mode 100644 docs/types/modules/_codec_tuple_.md delete mode 100644 docs/types/modules/_codec_typeregistry_.html delete mode 100644 docs/types/modules/_codec_typeregistry_.md delete mode 100644 docs/types/modules/_codec_u8a_.html delete mode 100644 docs/types/modules/_codec_u8a_.md delete mode 100644 docs/types/modules/_codec_u8afixed_.html delete mode 100644 docs/types/modules/_codec_u8afixed_.md delete mode 100644 docs/types/modules/_codec_uint_.html delete mode 100644 docs/types/modules/_codec_uint_.md delete mode 100644 docs/types/modules/_codec_utils_comparearray_.html delete mode 100644 docs/types/modules/_codec_utils_comparearray_.md delete mode 100644 docs/types/modules/_codec_utils_comparemap_.html delete mode 100644 docs/types/modules/_codec_utils_comparemap_.md delete mode 100644 docs/types/modules/_codec_utils_decodeu8a_.html delete mode 100644 docs/types/modules/_codec_utils_decodeu8a_.md delete mode 100644 docs/types/modules/_codec_vector_.html delete mode 100644 docs/types/modules/_codec_vector_.md delete mode 100644 docs/types/modules/_index_types_.html delete mode 100644 docs/types/modules/_index_types_.md delete mode 100644 docs/types/modules/_metadata_magicnumber_.html delete mode 100644 docs/types/modules/_metadata_magicnumber_.md delete mode 100644 docs/types/modules/_metadata_metadata_.html delete mode 100644 docs/types/modules/_metadata_metadata_.md delete mode 100644 docs/types/modules/_metadata_metadataversioned_.html delete mode 100644 docs/types/modules/_metadata_metadataversioned_.md delete mode 100644 docs/types/modules/_metadata_static_.html delete mode 100644 docs/types/modules/_metadata_static_.md delete mode 100644 docs/types/modules/_metadata_types_.html delete mode 100644 docs/types/modules/_metadata_types_.md delete mode 100644 docs/types/modules/_metadata_util_flattenuniq_.html delete mode 100644 docs/types/modules/_metadata_util_flattenuniq_.md delete mode 100644 docs/types/modules/_metadata_util_validatetypes_.html delete mode 100644 docs/types/modules/_metadata_util_validatetypes_.md delete mode 100644 docs/types/modules/_metadata_v0_calls_.html delete mode 100644 docs/types/modules/_metadata_v0_calls_.md delete mode 100644 docs/types/modules/_metadata_v0_events_.html delete mode 100644 docs/types/modules/_metadata_v0_events_.md delete mode 100644 docs/types/modules/_metadata_v0_metadata_.html delete mode 100644 docs/types/modules/_metadata_v0_metadata_.md delete mode 100644 docs/types/modules/_metadata_v0_modules_.html delete mode 100644 docs/types/modules/_metadata_v0_modules_.md delete mode 100644 docs/types/modules/_metadata_v0_static_.html delete mode 100644 docs/types/modules/_metadata_v0_static_.md delete mode 100644 docs/types/modules/_metadata_v1_calls_.html delete mode 100644 docs/types/modules/_metadata_v1_calls_.md delete mode 100644 docs/types/modules/_metadata_v1_events_.html delete mode 100644 docs/types/modules/_metadata_v1_events_.md delete mode 100644 docs/types/modules/_metadata_v1_metadata_.html delete mode 100644 docs/types/modules/_metadata_v1_metadata_.md delete mode 100644 docs/types/modules/_metadata_v1_static_.html delete mode 100644 docs/types/modules/_metadata_v1_static_.md delete mode 100644 docs/types/modules/_metadata_v1_storage_.html delete mode 100644 docs/types/modules/_metadata_v1_storage_.md delete mode 100644 docs/types/modules/_metadata_v1_tov0_.html delete mode 100644 docs/types/modules/_metadata_v1_tov0_.md delete mode 100644 docs/types/modules/_primitive_bool_.html delete mode 100644 docs/types/modules/_primitive_bool_.md delete mode 100644 docs/types/modules/_primitive_bytes_.html delete mode 100644 docs/types/modules/_primitive_bytes_.md delete mode 100644 docs/types/modules/_primitive_data_.html delete mode 100644 docs/types/modules/_primitive_data_.md delete mode 100644 docs/types/modules/_primitive_h160_.html delete mode 100644 docs/types/modules/_primitive_h160_.md delete mode 100644 docs/types/modules/_primitive_h256_.html delete mode 100644 docs/types/modules/_primitive_h256_.md delete mode 100644 docs/types/modules/_primitive_h512_.html delete mode 100644 docs/types/modules/_primitive_h512_.md delete mode 100644 docs/types/modules/_primitive_i128_.html delete mode 100644 docs/types/modules/_primitive_i128_.md delete mode 100644 docs/types/modules/_primitive_i16_.html delete mode 100644 docs/types/modules/_primitive_i16_.md delete mode 100644 docs/types/modules/_primitive_i256_.html delete mode 100644 docs/types/modules/_primitive_i256_.md delete mode 100644 docs/types/modules/_primitive_i32_.html delete mode 100644 docs/types/modules/_primitive_i32_.md delete mode 100644 docs/types/modules/_primitive_i64_.html delete mode 100644 docs/types/modules/_primitive_i64_.md delete mode 100644 docs/types/modules/_primitive_i8_.html delete mode 100644 docs/types/modules/_primitive_i8_.md delete mode 100644 docs/types/modules/_primitive_method_.html delete mode 100644 docs/types/modules/_primitive_method_.md delete mode 100644 docs/types/modules/_primitive_moment_.html delete mode 100644 docs/types/modules/_primitive_moment_.md delete mode 100644 docs/types/modules/_primitive_null_.html delete mode 100644 docs/types/modules/_primitive_null_.md delete mode 100644 docs/types/modules/_primitive_storagedata_.html delete mode 100644 docs/types/modules/_primitive_storagedata_.md delete mode 100644 docs/types/modules/_primitive_storagekey_.html delete mode 100644 docs/types/modules/_primitive_storagekey_.md delete mode 100644 docs/types/modules/_primitive_text_.html delete mode 100644 docs/types/modules/_primitive_text_.md delete mode 100644 docs/types/modules/_primitive_type_.html delete mode 100644 docs/types/modules/_primitive_type_.md delete mode 100644 docs/types/modules/_primitive_u128_.html delete mode 100644 docs/types/modules/_primitive_u128_.md delete mode 100644 docs/types/modules/_primitive_u16_.html delete mode 100644 docs/types/modules/_primitive_u16_.md delete mode 100644 docs/types/modules/_primitive_u256_.html delete mode 100644 docs/types/modules/_primitive_u256_.md delete mode 100644 docs/types/modules/_primitive_u32_.html delete mode 100644 docs/types/modules/_primitive_u32_.md delete mode 100644 docs/types/modules/_primitive_u64_.html delete mode 100644 docs/types/modules/_primitive_u64_.md delete mode 100644 docs/types/modules/_primitive_u8_.html delete mode 100644 docs/types/modules/_primitive_u8_.md delete mode 100644 docs/types/modules/_primitive_usize_.html delete mode 100644 docs/types/modules/_primitive_usize_.md delete mode 100644 docs/types/modules/_rpc_chainproperties_.html delete mode 100644 docs/types/modules/_rpc_chainproperties_.md delete mode 100644 docs/types/modules/_rpc_extrinsicstatus_.html delete mode 100644 docs/types/modules/_rpc_extrinsicstatus_.md delete mode 100644 docs/types/modules/_rpc_health_.html delete mode 100644 docs/types/modules/_rpc_health_.md delete mode 100644 docs/types/modules/_rpc_json_.html delete mode 100644 docs/types/modules/_rpc_json_.md delete mode 100644 docs/types/modules/_rpc_networkstate_.html delete mode 100644 docs/types/modules/_rpc_networkstate_.md delete mode 100644 docs/types/modules/_rpc_peerinfo_.html delete mode 100644 docs/types/modules/_rpc_peerinfo_.md delete mode 100644 docs/types/modules/_rpc_pendingextrinsics_.html delete mode 100644 docs/types/modules/_rpc_pendingextrinsics_.md delete mode 100644 docs/types/modules/_rpc_runtimeversion_.html delete mode 100644 docs/types/modules/_rpc_runtimeversion_.md delete mode 100644 docs/types/modules/_rpc_signedblock_.html delete mode 100644 docs/types/modules/_rpc_signedblock_.md delete mode 100644 docs/types/modules/_rpc_storagechangeset_.html delete mode 100644 docs/types/modules/_rpc_storagechangeset_.md delete mode 100644 docs/types/modules/_scripts_metadatamd_.html delete mode 100644 docs/types/modules/_scripts_metadatamd_.md delete mode 100644 docs/types/modules/_type_accountid_.html delete mode 100644 docs/types/modules/_type_accountid_.md delete mode 100644 docs/types/modules/_type_accountindex_.html delete mode 100644 docs/types/modules/_type_accountindex_.md delete mode 100644 docs/types/modules/_type_address_.html delete mode 100644 docs/types/modules/_type_address_.md delete mode 100644 docs/types/modules/_type_amount_.html delete mode 100644 docs/types/modules/_type_amount_.md delete mode 100644 docs/types/modules/_type_assetof_.html delete mode 100644 docs/types/modules/_type_assetof_.md delete mode 100644 docs/types/modules/_type_attestedcandidate_.html delete mode 100644 docs/types/modules/_type_attestedcandidate_.md delete mode 100644 docs/types/modules/_type_authorityid_.html delete mode 100644 docs/types/modules/_type_authorityid_.md delete mode 100644 docs/types/modules/_type_balance_.html delete mode 100644 docs/types/modules/_type_balance_.md delete mode 100644 docs/types/modules/_type_bft_.html delete mode 100644 docs/types/modules/_type_bft_.md delete mode 100644 docs/types/modules/_type_block_.html delete mode 100644 docs/types/modules/_type_block_.md delete mode 100644 docs/types/modules/_type_blocknumber_.html delete mode 100644 docs/types/modules/_type_blocknumber_.md delete mode 100644 docs/types/modules/_type_codehash_.html delete mode 100644 docs/types/modules/_type_codehash_.md delete mode 100644 docs/types/modules/_type_digest_.html delete mode 100644 docs/types/modules/_type_digest_.md delete mode 100644 docs/types/modules/_type_event_.html delete mode 100644 docs/types/modules/_type_event_.md delete mode 100644 docs/types/modules/_type_eventrecord_.html delete mode 100644 docs/types/modules/_type_eventrecord_.md delete mode 100644 docs/types/modules/_type_extrinsic_.html delete mode 100644 docs/types/modules/_type_extrinsic_.md delete mode 100644 docs/types/modules/_type_extrinsicera_.html delete mode 100644 docs/types/modules/_type_extrinsicera_.md delete mode 100644 docs/types/modules/_type_extrinsics_.html delete mode 100644 docs/types/modules/_type_extrinsics_.md delete mode 100644 docs/types/modules/_type_extrinsicsignature_.html delete mode 100644 docs/types/modules/_type_extrinsicsignature_.md delete mode 100644 docs/types/modules/_type_gas_.html delete mode 100644 docs/types/modules/_type_gas_.md delete mode 100644 docs/types/modules/_type_hash_.html delete mode 100644 docs/types/modules/_type_hash_.md delete mode 100644 docs/types/modules/_type_header_.html delete mode 100644 docs/types/modules/_type_header_.md delete mode 100644 docs/types/modules/_type_inherentofflinereport_.html delete mode 100644 docs/types/modules/_type_inherentofflinereport_.md delete mode 100644 docs/types/modules/_type_justification_.html delete mode 100644 docs/types/modules/_type_justification_.md delete mode 100644 docs/types/modules/_type_keyvalue_.html delete mode 100644 docs/types/modules/_type_keyvalue_.md delete mode 100644 docs/types/modules/_type_lockperiods_.html delete mode 100644 docs/types/modules/_type_lockperiods_.md delete mode 100644 docs/types/modules/_type_misbehaviorreport_.html delete mode 100644 docs/types/modules/_type_misbehaviorreport_.md delete mode 100644 docs/types/modules/_type_newaccountoutcome_.html delete mode 100644 docs/types/modules/_type_newaccountoutcome_.md delete mode 100644 docs/types/modules/_type_nonce_.html delete mode 100644 docs/types/modules/_type_nonce_.md delete mode 100644 docs/types/modules/_type_noncecompact_.html delete mode 100644 docs/types/modules/_type_noncecompact_.md delete mode 100644 docs/types/modules/_type_origin_.html delete mode 100644 docs/types/modules/_type_origin_.md delete mode 100644 docs/types/modules/_type_paraid_.html delete mode 100644 docs/types/modules/_type_paraid_.md delete mode 100644 docs/types/modules/_type_perbill_.html delete mode 100644 docs/types/modules/_type_perbill_.md delete mode 100644 docs/types/modules/_type_permill_.html delete mode 100644 docs/types/modules/_type_permill_.md delete mode 100644 docs/types/modules/_type_prefabwasmmodule_.html delete mode 100644 docs/types/modules/_type_prefabwasmmodule_.md delete mode 100644 docs/types/modules/_type_propindex_.html delete mode 100644 docs/types/modules/_type_propindex_.md delete mode 100644 docs/types/modules/_type_proposal_.html delete mode 100644 docs/types/modules/_type_proposal_.md delete mode 100644 docs/types/modules/_type_proposalindex_.html delete mode 100644 docs/types/modules/_type_proposalindex_.md delete mode 100644 docs/types/modules/_type_referendumindex_.html delete mode 100644 docs/types/modules/_type_referendumindex_.md delete mode 100644 docs/types/modules/_type_referenduminfo_.html delete mode 100644 docs/types/modules/_type_referenduminfo_.md delete mode 100644 docs/types/modules/_type_schedule_.html delete mode 100644 docs/types/modules/_type_schedule_.md delete mode 100644 docs/types/modules/_type_seedof_.html delete mode 100644 docs/types/modules/_type_seedof_.md delete mode 100644 docs/types/modules/_type_sessionkey_.html delete mode 100644 docs/types/modules/_type_sessionkey_.md delete mode 100644 docs/types/modules/_type_signature_.html delete mode 100644 docs/types/modules/_type_signature_.md delete mode 100644 docs/types/modules/_type_signaturepayload_.html delete mode 100644 docs/types/modules/_type_signaturepayload_.md delete mode 100644 docs/types/modules/_type_storedpendingchange_.html delete mode 100644 docs/types/modules/_type_storedpendingchange_.md delete mode 100644 docs/types/modules/_type_validatorprefs_.html delete mode 100644 docs/types/modules/_type_validatorprefs_.md delete mode 100644 docs/types/modules/_type_vestingschedule_.html delete mode 100644 docs/types/modules/_type_vestingschedule_.md delete mode 100644 docs/types/modules/_type_vote_.html delete mode 100644 docs/types/modules/_type_vote_.md delete mode 100644 docs/types/modules/_type_voteindex_.html delete mode 100644 docs/types/modules/_type_voteindex_.md delete mode 100644 docs/types/modules/_type_votethreshold_.html delete mode 100644 docs/types/modules/_type_votethreshold_.md delete mode 100644 docs/types/modules/_types_.html delete mode 100644 docs/types/modules/_types_.md diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index e5a675eddd..0000000000 --- a/docs/404.html +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -

404

How did we get here?
Take me home.
- - - diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html deleted file mode 100644 index cbb4b23a12..0000000000 --- a/docs/CONTRIBUTING.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - Contributing | polkadot-js/api - - - - - - - -
polkadot-js/api

Contributing

What?

Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. -A project is more like an open wiki than a standard guarded open source project.

Rules

There are a few basic ground-rules for contributors (including the maintainer(s) of the project):

  1. No --force pushes or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.
  2. Non-master branches, prefixed with a short name moniker (e.g. <initials>-<feature>) must be used for ongoing work.
  3. All modifications must be made in a pull-request to solicit feedback from other contributors.
  4. A pull-request must not be merged until CI has finished successfully.

Merging pull requests once CI is successful:

  • A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.
  • No PR should be merged until all reviews' comments are addressed.

Reviewing pull requests:

When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:

  • Buggy behaviour.
  • Undue maintenance burden.
  • Breaking with house coding style.
  • Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).
  • Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).
  • Uselessness (i.e. it does not strictly add a feature or fix a known issue).

Reviews may not be used as an effective veto for a PR because:

  • There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.
  • It does not fit well with some other contributors' longer-term vision for the project.

Releases

Declaring formal releases remains the prerogative of the project maintainer(s).

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.

Heritage

These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: https://github.com/Level/community/blob/master/CONTRIBUTING.md

- ← -

- - - diff --git a/docs/METHODS_EVENTS.html b/docs/METHODS_EVENTS.html deleted file mode 100644 index 7df4d4c038..0000000000 --- a/docs/METHODS_EVENTS.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - Events | polkadot-js/api - - - - - - - -
polkadot-js/api

Events

Events are emitted for certain operations on the runtime. The following sections describe the events that are part of the default Substrate runtime.

balances

▸ NewAccount(AccountId, Balance)

  • summary: A new account was created.

▸ ReapedAccount(AccountId)

  • summary: An account was reaped.

▸ Transfer(AccountId, AccountId, Balance, Balance)

  • summary: Transfer succeeded (from, to, value, fees).

contract

▸ CodeStored(Hash)

  • summary: Code with the specified hash has been stored.

▸ Dispatched(AccountId, bool)

  • summary: A call was dispatched from the given account. The bool signals whether it was successful execution or not.

▸ Instantiated(AccountId, AccountId)

  • summary: Contract deployed by address at the specified address.

▸ ScheduleUpdated(u32)

  • summary: Triggered when the current schedule is updated.

▸ Transfer(AccountId, AccountId, Balance)

  • summary: Transfer happened from -> to with given value as part of a message-call or create.

council

▸ BadReaperSlashed(AccountId)

  • summary: slashed reaper

▸ TallyFinalised(Vec<AccountId>, Vec<AccountId>)

  • summary: A tally (for approval votes of council seat(s)) has ended (with one or more new members).

▸ TallyStarted(u32)

  • summary: A tally (for approval votes of council seat(s)) has started.

▸ VoterReaped(AccountId, AccountId)

  • summary: reaped voter, reaper

councilMotions

▸ Approved(Hash)

  • summary: A motion was approved by the required threshold.

▸ Disapproved(Hash)

  • summary: A motion was not approved by the required threshold.

▸ Executed(Hash, bool)

  • summary: A motion was executed; bool is true if returned without error.

▸ Proposed(AccountId, ProposalIndex, Hash, u32)

  • summary: A motion (given hash) has been proposed (by given account) with a threshold (given u32).

▸ Voted(AccountId, Hash, bool, u32, u32)

  • summary: A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given as u32s respectively).

councilVoting

▸ TallyCancelation(Hash, u32, u32, u32)

  • summary: A voting tally has happened for a referendum cancellation vote. Last three are yes, no, abstain counts.

▸ TallyReferendum(Hash, u32, u32, u32)

  • summary: A voting tally has happened for a referendum vote. Last three are yes, no, abstain counts.

democracy

▸ Cancelled(ReferendumIndex)

▸ Executed(ReferendumIndex, bool)

▸ NotPassed(ReferendumIndex)

▸ Passed(ReferendumIndex)

▸ Proposed(PropIndex, Balance)

▸ Started(ReferendumIndex, VoteThreshold)

▸ Tabled(PropIndex, Balance, Vec<AccountId>)

fees

▸ Charged(u32, Amount)

  • summary: Fee charged (extrinsic_index, fee_amount)

grandpa

▸ NewAuthorities(Vec<(SessionKey,u64)>)

  • summary: New authority set has been applied.

indices

▸ NewAccountIndex(AccountId, AccountIndex)

  • summary: A new account index was assigned. This event is not triggered when an existing index is reassigned to another AccountId.

session

▸ NewSession(BlockNumber)

  • summary: New session has happened. Note that the argument is the session index, not the block number as the type might suggest.

staking

▸ OfflineSlash(AccountId, Balance)

  • summary: One validator (and their nominators) has been slashed by the given amount.

▸ OfflineWarning(AccountId, u32)

  • summary: One validator (and their nominators) has been given a offline-warning (they're still within their grace). The accrued number of slashes is recorded, too.

▸ Reward(Balance)

  • summary: All validators have been rewarded by the given balance.

sudo

▸ KeyChanged(AccountId)

  • summary: The sudoer just switched identity; the old key is supplied.

▸ Sudid(bool)

  • summary: A sudo just took place.

system

▸ ExtrinsicFailed()

  • summary: An extrinsic failed.

▸ ExtrinsicSuccess()

  • summary: An extrinsic completed successfully.

treasury

▸ Awarded(ProposalIndex, Balance, AccountId)

  • summary: Some funds have been allocated.

▸ Burnt(Balance)

  • summary: Some of our funds have been burnt.

▸ Proposed(ProposalIndex)

  • summary: New proposal.

▸ Rollover(Balance)

  • summary: Spending has finished; this is the amount that rolls over until next spend.

▸ Spending(Balance)

  • summary: We have ended a spend period and will now allocate funds.

- ← - - @polkadot/api - - → -

- - - diff --git a/docs/METHODS_EXTRINSICS.html b/docs/METHODS_EXTRINSICS.html deleted file mode 100644 index dfb00a7b1b..0000000000 --- a/docs/METHODS_EXTRINSICS.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - Extrinsics | polkadot-js/api - - - - - - - -
polkadot-js/api

Extrinsics

The following sections contain Extrinsics methods are part of the default Substrate runtime.

balances

▸ setBalance(who: Address, free: Compact<Balance>, reserved: Compact<Balance>)

  • summary: Set the balances of a given account.

▸ transfer(dest: Address, value: Compact<Balance>)

  • summary: Transfer some liquid free balance to another staker.

consensus

▸ noteOffline(offline: InherentOfflineReport)

  • summary: Note the previous block's validator missed their opportunity to propose a block.

▸ remark(_remark: Bytes)

  • summary: Make some on-chain remark.

▸ reportMisbehavior(_report: Bytes)

  • summary: Report some misbehaviour.

▸ setCode(new: Bytes)

  • summary: Set the new code.

▸ setHeapPages(pages: u64)

  • summary: Set the number of pages in the WebAssembly environment's heap.

▸ setStorage(items: Vec<KeyValue>)

  • summary: Set some items of storage.

contract

▸ call(dest: Address, value: Compact<Balance>, gas_limit: Compact<Gas>, data: Bytes)

  • summary: Make a call to a specified account, optionally transferring some balance.

▸ create(endowment: Compact<Balance>, gas_limit: Compact<Gas>, code_hash: CodeHash, data: Bytes)

  • summary: Create a new contract, optionally transfering some balance to the created account. Creation is executed as follows: - the destination address is computed based on the sender and hash of the code. - account is created at the computed address. - the ctor_code is executed in the context of the newly created account. Buffer returned after the execution is saved as the code of the account. That code will be invoked upon any message received by this account.

▸ putCode(gas_limit: Compact<Gas>, code: Bytes)

  • summary: Stores code in the storage. You can instantiate contracts only with stored code.

▸ updateSchedule(schedule: Schedule)

  • summary: Updates the schedule for metering contracts. The schedule must have a greater version than the stored schedule.

council

▸ presentWinner(candidate: Address, total: Compact<BalanceOf>, index: Compact<VoteIndex>)

  • summary: Claim that signed is one of the top Self::carry_count() + current_vote().1 candidates. Only works if the block_number >= current_vote().0 and < current_vote().0 + presentation_duration()``signed` should have at least

▸ reapInactiveVoter(reporter_index: Compact<u32>, who: Address, who_index: Compact<u32>, assumed_vote_index: Compact<VoteIndex>)

  • summary: Remove a voter. For it not to be a bond-consuming no-op, all approved candidate indices must now be either unregistered or registered to a candidate that registered the slot after the voter gave their last approval set. May be called by anyone. Returns the voter deposit to signed.

▸ removeMember(who: Address)

  • summary: Remove a particular member. A tally will happen instantly (if not already in a presentation period) to fill the seat if removal means that the desired members are not met. This is effective immediately.

▸ retractVoter(index: Compact<u32>)

  • summary: Remove a voter. All votes are cancelled and the voter deposit is returned.

▸ setApprovals(votes: Vec<bool>, index: Compact<VoteIndex>)

  • summary: Set candidate approvals. Approval slots stay valid as long as candidates in those slots are registered.

▸ setDesiredSeats(count: Compact<u32>)

  • summary: Set the desired member count; if lower than the current count, then seats will not be up election when they expire. If more, then a new vote will be started if one is not already in progress.

▸ setPresentationDuration(count: Compact<BlockNumber>)

  • summary: Set the presentation duration. If there is currently a vote being presented for, will invoke finalise_vote.

▸ setTermDuration(count: Compact<BlockNumber>)

  • summary: Set the presentation duration. If there is current a vote being presented for, will invoke finalise_vote.

▸ submitCandidacy(slot: Compact<u32>)

  • summary: Submit oneself for candidacy. Account must have enough transferrable funds in it to pay the bond.

councilMotions

▸ propose(threshold: Compact<u32>, proposal: Proposal)

▸ vote(proposal: Hash, index: Compact<ProposalIndex>, approve: bool)

councilVoting

▸ propose(proposal: Proposal)

▸ setCooloffPeriod(blocks: Compact<BlockNumber>)

▸ setVotingPeriod(blocks: Compact<BlockNumber>)

▸ veto(proposal_hash: Hash)

▸ vote(proposal: Hash, approve: bool)

democracy

▸ cancelQueued(when: Compact<BlockNumber>, which: Compact<u32>)

  • summary: Cancel a proposal queued for enactment.

▸ cancelReferendum(ref_index: Compact<ReferendumIndex>)

  • summary: Remove a referendum.

▸ propose(proposal: Proposal, value: Compact<BalanceOf>)

  • summary: Propose a sensitive action to be taken.

▸ second(proposal: Compact<PropIndex>)

  • summary: Propose a sensitive action to be taken.

▸ startReferendum(proposal: Proposal, threshold: VoteThreshold, delay: BlockNumber)

  • summary: Start a referendum.

▸ vote(ref_index: Compact<ReferendumIndex>, vote: Vote)

  • summary: Vote in a referendum. If vote.is_aye(), the vote is to enact the proposal; otherwise it is a vote to keep the status quo.

grandpa

▸ reportMisbehavior(_report: Bytes)

  • summary: Report some misbehaviour.

session

▸ forceNewSession(apply_rewards: bool)

  • summary: Forces a new session.

▸ setKey(key: SessionKey)

  • summary: Sets the session key of _validator to _key. This doesn't take effect until the next session.

▸ setLength(new: Compact<BlockNumber>)

  • summary: Set a new session length. Won't kick in until the next session change (at current length).

staking

▸ forceNewEra(apply_rewards: bool)

  • summary: Force there to be a new era. This also forces a new session immediately after. apply_rewards should be true for validators to get the session reward.

▸ nominate(target: Address)

▸ registerPreferences(intentions_index: Compact<u32>, prefs: ValidatorPrefs)

  • summary: Set the given account's preference for slashing behaviour should they be a validator. An error (no-op) if Self::intentions()[intentions_index] != origin.

▸ setBondingDuration(new: Compact<BlockNumber>)

  • summary: The length of the bonding duration in eras.

▸ setInvulnerables(validators: Vec<AccountId>)

  • summary: Set the validators who cannot be slashed (if any).

▸ setOfflineSlashGrace(new: Compact<u32>)

  • summary: Set the offline slash grace period.

▸ setSessionsPerEra(new: Compact<BlockNumber>)

  • summary: Set the number of sessions in an era.

▸ setValidatorCount(new: Compact<u32>)

  • summary: The ideal number of validators.

▸ stake()

  • summary: Declare the desire to stake for the transactor. Effects will be felt at the beginning of the next era.

▸ unnominate(target_index: Compact<u32>)

  • summary: Will panic if called when source isn't currently nominating target. Updates Nominating, NominatorsFor and NominationBalance.

▸ unstake(intentions_index: Compact<u32>)

  • summary: Retract the desire to stake for the transactor. Effects will be felt at the beginning of the next era.

sudo

▸ setKey(new: Address)

▸ sudo(proposal: Proposal)

timestamp

▸ set(now: Compact<Moment>)

  • summary: Set the current time. Extrinsic with this call should be placed at the specific position in the each block (specified by the Trait::TIMESTAMP_SET_POSITION) typically at the start of the each block. This call should be invoked exactly once per block. It will panic at the finalization phase, if this call hasn't been invoked by that time. The timestamp should be greater than the previous one by the amount specified by block_period.

treasury

▸ approveProposal(proposal_id: Compact<ProposalIndex>)

  • summary: Approve a proposal. At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned.

▸ configure(proposal_bond: Compact<Permill>, proposal_bond_minimum: Compact<BalanceOf>, spend_period: Compact<BlockNumber>, burn: Compact<Permill>)

  • summary: (Re-)configure this module.

▸ proposeSpend(value: Compact<BalanceOf>, beneficiary: Address)

  • summary: Put forward a suggestion for spending. A deposit proportional to the value is reserved and slashed if the proposal is rejected. It is returned once the proposal is awarded.

▸ rejectProposal(proposal_id: Compact<ProposalIndex>)

  • summary: Reject a proposed spend. The original deposit will be slashed.

▸ setPot(new_pot: Compact<BalanceOf>)

  • summary: Set the balance of funds available to spend.

- ← - - System events (defaults) - - → -

- - - diff --git a/docs/METHODS_RPC.html b/docs/METHODS_RPC.html deleted file mode 100644 index 8b03149a0b..0000000000 --- a/docs/METHODS_RPC.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - JSON-RPC | polkadot-js/api - - - - - - - -
polkadot-js/api

JSON-RPC

The following sections contain RPC methods that are Remote Calls available by default and allow you to interact with the actual node, query, and submit. The RPCs are provided by Substrate itself.

author

Authoring of network items

▸ pendingExtrinsics(): PendingExtrinsics

  • summary: Returns all pending extrinsics, potentially grouped by sender

▸ submitAndWatchExtrinsic(extrinsic: Extrinsic): ExtrinsicStatus

  • summary: Subscribe and watch an extrinsic until unsubscribed

▸ submitExtrinsic(extrinsic: Extrinsic): Hash

  • summary: Submit a fully formatted extrinsic for block inclusion

chain

Retrieval of chain data

▸ getBlock(hash?: Hash): SignedBlock

  • summary: Get header and body of a relay chain block

▸ getBlockHash(blockNumber?: BlockNumber): Hash

  • summary: Get the block hash for a specific block

▸ getFinalisedHead(): Hash

  • summary: Get hash of the last finalised block in the canon chain

▸ getHeader(hash?: Hash): Header

  • summary: Retrieves the header for a specific block

▸ getRuntimeVersion(hash?: Hash): RuntimeVersion

  • summary: Get the runtime version (alias of state_getRuntimeVersion)

▸ subscribeFinalisedHeads(): Header

  • summary: Retrieves the best finalised header via subscription

▸ subscribeNewHead(): Header

  • summary: Retrieves the best header via subscription

▸ subscribeRuntimeVersion(): RuntimeVersion

  • summary: Retrieves the runtime version via subscription

state

Query of state

▸ call(method: Text, data: Bytes, block?: Hash): Bytes

  • summary: Perform a call to a builtin on the chain

▸ getMetadata(block?: Hash): Metadata

  • summary: Returns the runtime metadata

▸ getRuntimeVersion(hash?: Hash): RuntimeVersion

  • summary: Get the runtime version

▸ getStorage(key: StorageKey, block?: Hash): StorageData

  • summary: Retrieves the storage for a key

▸ getStorageHash(key: StorageKey, block?: Hash): Hash

  • summary: Retrieves the storage hash

▸ getStorageSize(key: StorageKey, block?: Hash): u64

  • summary: Retrieves the storage size

▸ queryStorage(keys: Vec<StorageKey>, startBlock: Hash, block?: Hash): Vec<StorageChangeSet>

  • summary: Query historical storage entries (by key) starting from a start block

▸ subscribeStorage(keys: Vec<StorageKey>): StorageChangeSet

  • summary: Subscribes to storage changes for the provided keys

system

Methods to retrieve system info

▸ chain(): Text

  • summary: Retrieves the chain

▸ health(): Health

  • summary: Return health status of the node

▸ name(): Text

  • summary: Retrieves the node name

▸ networkState(): NetworkState

  • summary: Returns current state of the network

▸ peers(): Vec<PeerInfo>

  • summary: Returns the currently connected peers

▸ properties(): ChainProperties

  • summary: Get a custom set of properties as a JSON object, defined in the chain spec

▸ version(): Text

  • summary: Retrieves the version of the node

- ← - - State storage (defaults) - - → -

- - - diff --git a/docs/METHODS_STORAGE.html b/docs/METHODS_STORAGE.html deleted file mode 100644 index 732d640cdd..0000000000 --- a/docs/METHODS_STORAGE.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - Storage | polkadot-js/api - - - - - - - -
polkadot-js/api

Storage

The following sections contain Storage methods are part of the default Substrate runtime.

balances

▸ creationFee(): Balance

  • summary: The fee required to create an account. At least as big as ReclaimRebate.

▸ existentialDeposit(): Balance

  • summary: The minimum amount allowed to keep an account open.

▸ freeBalance(AccountId): Balance

  • summary: The 'free' balance of a given account. This is the only balance that matters in terms of most operations on tokens. It is alone used to determine the balance when in the contract execution environment. When this balance falls below the value of ExistentialDeposit, then the 'current account' is deleted: specifically FreeBalance. Furthermore, OnFreeBalanceZero callback is invoked, giving a chance to external modules to cleanup data associated with the deleted account. system::AccountNonce is also deleted if ReservedBalance is also zero (it also gets collapsed to zero if it ever becomes less than ExistentialDeposit.

▸ reservedBalance(AccountId): Balance

  • summary: The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all. This balance is a 'reserve' balance that other subsystems use in order to set aside tokens that are still 'owned' by the account holder, but which are suspendable. (This is different and wholly unrelated to the Bondage system used in the staking module.) When this balance falls below the value of ExistentialDeposit, then this 'reserve account' is deleted: specifically, ReservedBalance. system::AccountNonce is also deleted if FreeBalance is also zero (it also gets collapsed to zero if it ever becomes less than ExistentialDeposit.

▸ totalIssuance(): Balance

  • summary: The total amount of stake on the system.

▸ transferFee(): Balance

  • summary: The fee required to make a transfer.

▸ vesting(AccountId): Option<VestingSchedule>

  • summary: Information regarding the vesting of a given account.

consensus

▸ originalAuthorities(): Option<Vec<SessionKey>>

contract

▸ blockGasLimit(): Gas

  • summary: The maximum amount of gas that could be expended per block.

▸ callBaseFee(): Gas

  • summary: The fee charged for a call into a contract.

▸ codeHashOf(AccountId): Option<CodeHash>

  • summary: The code associated with a given account.

▸ codeStorage(CodeHash): Option<PrefabWasmModule>

  • summary: A mapping between an original code hash and instrumented wasm code, ready for the execution.

▸ contractFee(): Balance

  • summary: The fee required to create a contract. At least as big as staking's ReclaimRebate.

▸ createBaseFee(): Gas

  • summary: The fee charged for a create of a contract.

▸ currentSchedule(): Schedule

  • summary: Current cost schedule for contracts.

▸ gasPrice(): Balance

  • summary: The price of one unit of gas.

▸ gasSpent(): Gas

  • summary: Gas spent so far in this block.

▸ maxDepth(): u32

  • summary: The maximum nesting level of a call/create stack.

▸ pristineCode(CodeHash): Option<Bytes>

  • summary: A mapping from an original code hash to the original code, untouched by instrumentation.

council

▸ activeCouncil(): Vec<(AccountId,BlockNumber)>

  • summary: The current council. When there's a vote going on, this should still be used for executive matters. The block number (second element in the tuple) is the block that their position is active until (calculated by the sum of the block number when the council member was elected and their term duration).

▸ approvalsOf(AccountId): Vec<bool>

  • summary: A list of votes for each voter, respecting the last cleared vote index that this voter was last active at.

▸ candidacyBond(): BalanceOf

  • summary: How much should be locked up in order to submit one's candidacy.

▸ candidateCount(): u32

▸ candidates(): Vec<AccountId>

  • summary: The present candidate list.

▸ carryCount(): u32

  • summary: How many runners-up should have their approvals persist until the next vote.

▸ desiredSeats(): u32

  • summary: Number of accounts that should be sitting on the council.

▸ inactiveGracePeriod(): VoteIndex

  • summary: How many vote indexes need to go by after a target voter's last vote before they can be reaped if their approvals are moot.

▸ lastActiveOf(AccountId): Option<VoteIndex>

  • summary: The last cleared vote index that this voter was last active at.

▸ leaderboard(): Option<Vec<(BalanceOf,AccountId)>>

  • summary: Get the leaderboard if we;re in the presentation phase.

▸ nextFinalise(): Option<(BlockNumber,u32,Vec<AccountId>)>

  • summary: The accounts holding the seats that will become free on the next tally.

▸ presentSlashPerVoter(): BalanceOf

  • summary: The punishment, per voter, if you provide an invalid presentation.

▸ presentationDuration(): BlockNumber

  • summary: How long to give each top candidate to present themselves after the vote ends.

▸ registerInfoOf(AccountId): Option<(VoteIndex,u32)>

  • summary: The vote index and list slot that the candidate who was registered or None if they are not currently registered.

▸ snapshotedStakes(): Vec<BalanceOf>

  • summary: The stakes as they were at the point that the vote ended.

▸ termDuration(): BlockNumber

  • summary: How long each position is active for.

▸ voteCount(): VoteIndex

  • summary: The total number of votes that have happened or are in progress.

▸ voters(): Vec<AccountId>

  • summary: The present voter list.

▸ votingBond(): BalanceOf

  • summary: How much should be locked up in order to be able to submit votes.

▸ votingPeriod(): BlockNumber

  • summary: How often (in blocks) to check for new votes.

councilMotions

▸ proposalCount(): u32

  • summary: Proposals so far.

▸ proposalOf(Hash): Option<Proposal>

  • summary: Actual proposal for a given hash, if it's current.

▸ proposals(): Vec<Hash>

  • summary: The (hashes of) the active proposals.

▸ voting(Hash): Option<(ProposalIndex,u32,Vec<AccountId>,Vec<AccountId>)>

  • summary: Votes for a given proposal: (required_yes_votes, yes_voters, no_voters).

councilVoting

▸ cooloffPeriod(): BlockNumber

▸ councilVoteOf((Hash,AccountId)): Option<bool>

▸ enactDelayPeriod(): BlockNumber

  • summary: Number of blocks by which to delay enactment of successful, non-unanimous-council-instigated referendum proposals.

▸ proposalOf(Hash): Option<Proposal>

▸ proposalVoters(Hash): Vec<AccountId>

▸ proposals(): Vec<(BlockNumber,Hash)>

▸ vetoedProposal(Hash): Option<(BlockNumber,Vec<AccountId>)>

▸ votingPeriod(): BlockNumber

democracy

▸ bondage(AccountId): BlockNumber

  • summary: The block at which the who's funds become liquid.

▸ depositOf(PropIndex): Option<(BalanceOf,Vec<AccountId>)>

  • summary: Those who have locked a deposit.

▸ dispatchQueue(BlockNumber): Vec<Option<(Proposal,ReferendumIndex)>>

  • summary: Queue of successful referenda to be dispatched.

▸ launchPeriod(): BlockNumber

  • summary: How often (in blocks) new public referenda are launched.

▸ maxLockPeriods(): LockPeriods

  • summary: The maximum number of additional lock periods a voter may offer to strengthen their vote. Multiples of PublicDelay.

▸ minimumDeposit(): BalanceOf

  • summary: The minimum amount to be used as a deposit for a public referendum proposal.

▸ nextTally(): ReferendumIndex

  • summary: The next referendum index that should be tallied.

▸ publicDelay(): BlockNumber

  • summary: The delay before enactment for all public referenda.

▸ publicPropCount(): PropIndex

  • summary: The number of (public) proposals that have been made so far.

▸ publicProps(): Vec<(PropIndex,Proposal,AccountId)>

  • summary: The public proposals. Unsorted.

▸ referendumCount(): ReferendumIndex

  • summary: The next free referendum index, aka the number of referendums started so far.

▸ referendumInfoOf(ReferendumIndex): Option<ReferendumInfo>

  • summary: Information concerning any given referendum.

▸ voteOf((ReferendumIndex,AccountId)): Vote

  • summary: Get the vote in a given referendum of a particular voter. The result is meaningful only if voters_for includes the voter when called with the referendum (you'll get the default Vote value otherwise). If you don't want to check voters_for, then you can also check for simple existence with VoteOf::exists first.

▸ votersFor(ReferendumIndex): Vec<AccountId>

  • summary: Get the voters for the current proposal.

▸ votingPeriod(): BlockNumber

  • summary: How often (in blocks) to check for new votes.

fees

▸ currentTransactionFee(u32): AssetOf

  • summary: The extrinsic_index => accumulated_fees map, containing records to track the overall charged fees for each transaction. All records should be removed at finalise stage.

▸ transactionBaseFee(): AssetOf

  • summary: The fee to be paid for making a transaction; the base.

▸ transactionByteFee(): AssetOf

  • summary: The fee to be paid for making a transaction; the per-byte portion.

grandpaFinality

▸ pendingChange(): Option<StoredPendingChange>

indices

▸ enumSet(AccountIndex): Vec<AccountId>

  • summary: The enumeration sets.

▸ nextEnumSet(): AccountIndex

  • summary: The next free enumeration set.

session

▸ currentIndex(): BlockNumber

  • summary: Current index of the session.

▸ currentStart(): Moment

  • summary: Timestamp when current session started.

▸ forcingNewSession(): Option<bool>

  • summary: New session is being forced is this entry exists; in which case, the boolean value is whether the new session should be considered a normal rotation (rewardable) or exceptional (slashable).

▸ lastLengthChange(): Option<BlockNumber>

  • summary: Block at which the session length last changed.

▸ nextKeyFor(AccountId): Option<SessionKey>

  • summary: The next key for a given validator.

▸ nextSessionLength(): Option<BlockNumber>

  • summary: The next session length.

▸ sessionLength(): BlockNumber

  • summary: Current length of the session.

▸ validators(): Vec<AccountId>

  • summary: The current set of validators.

staking

▸ bondage(AccountId): BlockNumber

  • summary: The block at which the who's funds become entirely liquid.

▸ bondingDuration(): BlockNumber

  • summary: The length of the bonding duration in blocks.

▸ currentEra(): BlockNumber

  • summary: The current era index.

▸ currentNominatorsFor(AccountId): Vec<AccountId>

  • summary: Nominators for a particular account that is in action right now.

▸ currentOfflineSlash(): BalanceOf

  • summary: Slash, per validator that is taken for the first time they are found to be offline.

▸ currentSessionReward(): BalanceOf

  • summary: Maximum reward, per validator, that is provided per acceptable session.

▸ forcingNewEra(): Option<Null>

  • summary: We are forcing a new era.

▸ intentions(): Vec<AccountId>

  • summary: All the accounts with a desire to stake.

▸ invulerables(): Vec<AccountId>

  • summary: Any validators that may never be slashed or forcible kicked. It's a Vec since they're easy to initialise and the performance hit is minimal (we expect no more than four invulnerables) and restricted to testnets.

▸ lastEraLengthChange(): BlockNumber

  • summary: The session index at which the era length last changed.

▸ minimumValidatorCount(): u32

  • summary: Minimum number of staking participants before emergency conditions are imposed.

▸ nextSessionsPerEra(): Option<BlockNumber>

  • summary: The next value of sessions per era.

▸ nominating(AccountId): Option<AccountId>

  • summary: All nominator -> nominee relationships.

▸ nominatorsFor(AccountId): Vec<AccountId>

  • summary: Nominators for a particular account.

▸ offlineSlash(): Perbill

  • summary: Slash, per validator that is taken for the first time they are found to be offline.

▸ offlineSlashGrace(): u32

  • summary: Number of instances of offline reports before slashing begins for validators.

▸ recentlyOffline(): Vec<(AccountId,BlockNumber,u32)>

  • summary: Most recent RECENT_OFFLINE_COUNT instances. (who it was, when it was reported, how many instances they were offline for).

▸ sessionReward(): Perbill

  • summary: Maximum reward, per validator, that is provided per acceptable session.

▸ sessionsPerEra(): BlockNumber

  • summary: The length of a staking era in sessions.

▸ slashCount(AccountId): u32

  • summary: The number of times a given validator has been reported offline. This gets decremented by one each era that passes.

▸ stakeRange(): (BalanceOf,BalanceOf)

  • summary: The highest and lowest staked validator slashable balances.

▸ validatorCount(): u32

  • summary: The ideal number of staking participants.

▸ validatorPreferences(AccountId): ValidatorPrefs

  • summary: Preferences that a validator has.

sudo

▸ key(): AccountId

system

▸ accountNonce(AccountId): Index

▸ allExtrinsicsLen(): Option<u32>

▸ blockHash(BlockNumber): Hash

▸ digest(): Digest

▸ events(): Vec<EventRecord>

▸ extrinsicCount(): Option<u32>

▸ extrinsicData(u32): Bytes

▸ extrinsicsRoot(): Hash

▸ number(): BlockNumber

  • summary: The current block number being processed. Set by execute_block.

▸ parentHash(): Hash

▸ randomSeed(): Hash

timestamp

▸ blockPeriod(): Moment

  • summary: The minimum (and advised) period between blocks.

▸ didUpdate(): bool

  • summary: Did the timestamp get updated in this block?

▸ now(): Moment

  • summary: Current time for the current block.

treasury

▸ approvals(): Vec<ProposalIndex>

  • summary: Proposal indices that have been approved but not yet awarded.

▸ burn(): Permill

  • summary: Percentage of spare funds (if any) that are burnt per spend period.

▸ pot(): BalanceOf

  • summary: Total funds available to this module for spending.

▸ proposalBond(): Permill

  • summary: Proportion of funds that should be bonded in order to place a proposal. An accepted proposal gets these back. A rejected proposal doesn't.

▸ proposalBondMinimum(): BalanceOf

  • summary: Minimum amount of funds that should be placed in a deposit for making a proposal.

▸ proposalCount(): ProposalIndex

  • summary: Number of proposals that have been made.

▸ proposals(ProposalIndex): Option<Proposal>

  • summary: Proposals that have been made.

▸ spendPeriod(): BlockNumber

  • summary: Period between successive spends.

substrate

These are keys that are always available to the runtime implementation

▸ authorityCount(): u32

  • summary: Number of authorities.

▸ authorityPrefix(): u32

  • summary: Prefix under which authorities are storied.

▸ changesTrieConfig(): u32

  • summary: Changes trie configuration is stored under this key.

▸ code(): Bytes

  • summary: Wasm code of the runtime.

▸ extrinsicIndex(): u32

  • summary: Current extrinsic index (u32) is stored under this key.

▸ heapPages(): u64

  • summary: Number of wasm linear memory pages required for execution of the runtime.

- ← - - Extrinsics (defaults) - - → -

- - - diff --git a/docs/SUMMARY.html b/docs/SUMMARY.html deleted file mode 100644 index 7c9fc06d6a..0000000000 --- a/docs/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Packages | polkadot-js/api - - - - - - - -
polkadot-js/api

Packages

Interfaces

Examples

- - - diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 8748c5c67f..4135e17436 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -36,196 +36,3 @@ - [Display system events](examples/rx/08_system_events/README.md)( - [Transaction with events](examples/rx/09_transfer_events/README.md) - [Upgrade via sudo](examples/rx/10_upgrade_chain/README.md) - - - - - -- [hidden](types/classes/_codec_base_.base.md) -- [hidden](types/classes/_codec_compact_.compact.md) -- [hidden](types/classes/_codec_enum_.enum.md) -- [hidden](types/classes/_codec_enumtype_.enumtype.md) -- [hidden](types/classes/_codec_int_.int.md) -- [hidden](types/classes/_codec_option_.option.md) -- [hidden](types/classes/_codec_set_.set.md) -- [hidden](types/classes/_codec_struct_.struct.md) -- [hidden](types/classes/_codec_tuple_.tuple.md) -- [hidden](types/classes/_codec_typeregistry_.typeregistry.md) -- [hidden](types/classes/_codec_u8a_.u8a.md) -- [hidden](types/classes/_codec_u8afixed_.u8afixed.md) -- [hidden](types/classes/_codec_uint_.uint.md) -- [hidden](types/classes/_codec_vector_.vector.md) - - - -- [hidden](types/classes/_primitive_bool_.bool.md) -- [hidden](types/classes/_primitive_bytes_.bytes.md) -- [hidden](types/classes/_primitive_data_.data.md) -- [hidden](types/classes/_primitive_h160_.h160.md) -- [hidden](types/classes/_primitive_h256_.h256.md) -- [hidden](types/classes/_primitive_h512_.h512.md) -- [hidden](types/classes/_primitive_i128_.i128.md) -- [hidden](types/classes/_primitive_i16_.i16.md) -- [hidden](types/classes/_primitive_i256_.i256.md) -- [hidden](types/classes/_primitive_i32_.i32.md) -- [hidden](types/classes/_primitive_i64_.i64.md) -- [hidden](types/classes/_primitive_i8_.i8.md) -- [hidden](types/classes/_primitive_method_.method.md) -- [hidden](types/classes/_primitive_method_.methodindex.md) -- [hidden](types/classes/_primitive_moment_.moment.md) -- [hidden](types/classes/_primitive_null_.null.md) -- [hidden](types/classes/_primitive_storagedata_.storagedata.md) -- [hidden](types/classes/_primitive_storagekey_.storagekey.md) -- [hidden](types/classes/_primitive_text_.text.md) -- [hidden](types/classes/_primitive_type_.type.md) -- [hidden](types/classes/_primitive_u128_.u128.md) -- [hidden](types/classes/_primitive_u16_.u16.md) -- [hidden](types/classes/_primitive_u256_.u256.md) -- [hidden](types/classes/_primitive_u32_.u32.md) -- [hidden](types/classes/_primitive_u64_.u64.md) -- [hidden](types/classes/_primitive_u8_.u8.md) -- [hidden](types/classes/_primitive_usize_.usize.md) - - -- [hidden](types/classes/_type_header_.headerextended.md) -- [hidden](api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md) - - - -- [hidden](types/classes/_metadata_index_.metadata.md) -- [hidden](types/classes/_metadata_magicnumber_.magicnumber.md) -- [hidden](types/classes/_metadata_metadataversioned_.metadataversioned.md) -- [hidden](types/classes/_metadata_v0_calls_.outerdispatchcall.md) -- [hidden](types/classes/_metadata_v0_calls_.outerdispatchmetadata.md) -- [hidden](types/classes/_metadata_v0_events_.eventmetadata.md) -- [hidden](types/classes/_metadata_v0_events_.outereventmetadata.md) -- [hidden](types/classes/_metadata_v0_events_.outereventmetadataevent.md) -- [hidden](types/classes/_metadata_v0_index_.metadatav0.md) -- [hidden](types/classes/_metadata_v0_modules_.callmetadata.md) -- [hidden](types/classes/_metadata_v0_modules_.functionargumentmetadata.md) -- [hidden](types/classes/_metadata_v0_modules_.functionmetadata.md) -- [hidden](types/classes/_metadata_v0_modules_.,maptype.md) -- [hidden](types/classes/_metadata_v0_modules_.modulemetadata.md) -- [hidden](types/classes/_metadata_v0_modules_.runtimemodulemetadata.md) -- [hidden](types/classes/_metadata_v0_modules_.storagefunctionmetadata.md) -- [hidden](types/classes/_metadata_v0_modules_.storagefunctionmodifier.md) -- [hidden](types/classes/_metadata_v0_modules_.storagefunctiontype.md) -- [hidden](types/classes/_metadata_v0_modules_.storagefunctiontype_map.md) -- [hidden](types/classes/_metadata_v0_modules_.storagemetadata.md) -- [hidden](types/classes/_metadata_v1_calls_.metadatacall.md) -- [hidden](types/classes/_metadata_v1_calls_.metadatacallarg.md) -- [hidden](types/classes/_metadata_v1_events_.metadataevent.md) -- [hidden](types/classes/_metadata_v1_index_.metadatamodule.md) -- [hidden](types/classes/_metadata_v1_index_.metadatav1.md) -- [hidden](types/classes/_metadata_v1_storage_.default.md) -- [hidden](types/classes/_metadata_v1_storage_.maptype.md) -- [hidden](types/classes/_metadata_v1_storage_.metadatastorage.md) -- [hidden](types/classes/_metadata_v1_storage_.metadatastoragemodifier.md) -- [hidden](types/classes/_metadata_v1_storage_.metadatastoragetype.md) -- [hidden](types/classes/_metadata_v1_storage_.optional.md) -- [hidden](types/classes/_metadata_v1_storage_.plaintype.md) - - - -- [hidden](types/classes/_type_accountid_.accountid.md) -- [hidden](types/classes/_type_accountid_.accountidof.md) -- [hidden](types/classes/_type_accountindex_.accountindex.md) -- [hidden](types/classes/_type_address_.address.md) -- [hidden](types/classes/_type_amount_.amount.md) -- [hidden](types/classes/_type_assetof_.assetof.md) -- [hidden](types/classes/_type_attestedcandidate_.attestedcandidate.md) -- [hidden](types/classes/_type_attestedcandidate_.availabilityvote.md) -- [hidden](types/classes/_type_attestedcandidate_.balanceupload.md) -- [hidden](types/classes/_type_attestedcandidate_.candidatereceipt.md) -- [hidden](types/classes/_type_attestedcandidate_.candidatesignature.md) -- [hidden](types/classes/_type_attestedcandidate_.egressqueueroot.md) -- [hidden](types/classes/_type_attestedcandidate_.explicitcandidatesignature.md) -- [hidden](types/classes/_type_attestedcandidate_.headdata.md) -- [hidden](types/classes/_type_attestedcandidate_.implicitcandidatesignature.md) -- [hidden](types/classes/_type_attestedcandidate_.validityattestation.md) -- [hidden](types/classes/_type_attestedcandidate_.validityvote.md) -- [hidden](types/classes/_type_authorityid_.authorityid.md) -- [hidden](types/classes/_type_balance_.balance.md) -- [hidden](types/classes/_type_balance_.balanceof.md) -- [hidden](types/classes/_type_bft_.bftauthoritysignature.md) -- [hidden](types/classes/_type_bft_.bfthashsignature.md) -- [hidden](types/classes/_type_block_.block.md) -- [hidden](types/classes/_type_blocknumber_.blocknumber.md) -- [hidden](types/classes/_type_chainproperties_.chainproperties.md) -- [hidden](types/classes/_type_codehash_.codehash.md) -- [hidden](types/classes/_type_digest_.authoritieschange.md) -- [hidden](types/classes/_type_digest_.changestrieroot.md) -- [hidden](types/classes/_type_digest_.digest.md) -- [hidden](types/classes/_type_digest_.digestitem.md) -- [hidden](types/classes/_type_digest_.other.md) -- [hidden](types/classes/_type_digest_.seal.md) -- [hidden](types/classes/_type_event_.event.md) -- [hidden](types/classes/_type_event_.eventdata.md) -- [hidden](types/classes/_type_event_.eventindex.md) -- [hidden](types/classes/_type_eventrecord_.applyextrinsic.md) -- [hidden](types/classes/_type_eventrecord_.eventrecord.md) -- [hidden](types/classes/_type_eventrecord_.finalization.md) -- [hidden](types/classes/_type_eventrecord_.phase.md) -- [hidden](types/classes/_type_extrinsic_.extrinsic.md) -- [hidden](types/classes/_type_extrinsicera_.extrinsicera.md) -- [hidden](types/classes/_type_extrinsics_.extrinsics.md) -- [hidden](types/classes/_type_extrinsicsignature_.extrinsicsignature.md) -- [hidden](types/classes/_type_extrinsicstatus_.broadcast.md) -- [hidden](types/classes/_type_extrinsicstatus_.dropped.md) -- [hidden](types/classes/_type_extrinsicstatus_.extrinsicstatus.md) -- [hidden](types/classes/_type_extrinsicstatus_.finalised.md) -- [hidden](types/classes/_type_extrinsicstatus_.future.md) -- [hidden](types/classes/_type_extrinsicstatus_.invalid.md) -- [hidden](types/classes/_type_extrinsicstatus_.ready.md) -- [hidden](types/classes/_type_extrinsicstatus_.usurped.md) -- [hidden](types/classes/_type_gas_.gas.md) -- [hidden](types/classes/_type_hash_.hash.md) -- [hidden](types/classes/_type_header_.header.md) -- [hidden](types/classes/_type_health_.health.md) -- [hidden](types/classes/_type_inherentofflinereport_.inherentofflinereport.md) -- [hidden](types/classes/_type_justification_.justification.md) -- [hidden](types/classes/_type_justification_.rhdjustification.md) -- [hidden](types/classes/_type_keyvalue_.keyvalue.md) -- [hidden](types/classes/_type_keyvalue_.keyvalueoption.md) -- [hidden](types/classes/_type_lockperiods_.lockperiods.md) -- [hidden](types/classes/_type_misbehaviorreport_.bftatreport.md) -- [hidden](types/classes/_type_misbehaviorreport_.bftdoublecommit.md) -- [hidden](types/classes/_type_misbehaviorreport_.bftdoubleprepare.md) -- [hidden](types/classes/_type_misbehaviorreport_.bftdoublepropose.md) -- [hidden](types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md) -- [hidden](types/classes/_type_misbehaviorreport_.misbehaviorkind.md) -- [hidden](types/classes/_type_misbehaviorreport_.misbehaviorreport.md) -- [hidden](types/classes/_type_newaccountoutcome_.newaccountoutcome.md) -- [hidden](types/classes/_type_nonce_.nonce.md) -- [hidden](types/classes/_type_noncecompact_.noncecompact.md) -- [hidden](types/classes/_type_origin_.origin.md) -- [hidden](types/classes/_type_paraid_.paraid.md) -- [hidden](types/classes/_type_peerinfo_.peerinfo.md) -- [hidden](types/classes/_type_pendingextrinsics_.pendingextrinsics.md) -- [hidden](types/classes/_type_perbill_.perbill.md) -- [hidden](types/classes/_type_permill_.permill.md) -- [hidden](types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md) -- [hidden](types/classes/_type_propindex_.propindex.md) -- [hidden](types/classes/_type_proposal_.proposal.md) -- [hidden](types/classes/_type_proposalindex_.proposalindex.md) -- [hidden](types/classes/_type_referendumindex_.referendumindex.md) -- [hidden](types/classes/_type_referenduminfo_.referenduminfo.md) -- [hidden](types/classes/_type_runtimeversion_.apiid.md) -- [hidden](types/classes/_type_runtimeversion_.runtimeversion.md) -- [hidden](types/classes/_type_runtimeversion_.runtimeversionapi.md) -- [hidden](types/classes/_type_schedule_.schedule.md) -- [hidden](types/classes/_type_seedof_.seedof.md) -- [hidden](types/classes/_type_sessionkey_.sessionkey.md) -- [hidden](types/classes/_type_signature_.ed25519signature.md) -- [hidden](types/classes/_type_signature_.signature.md) -- [hidden](types/classes/_type_signature_.sr25519signature.md) -- [hidden](types/classes/_type_signaturepayload_.signaturepayload.md) -- [hidden](types/classes/_type_signedblock_.signedblock.md) -- [hidden](types/classes/_type_storagechangeset_.storagechangeset.md) -- [hidden](types/classes/_type_storedpendingchange_.nextauthority.md) -- [hidden](types/classes/_type_storedpendingchange_.storedpendingchange.md) -- [hidden](types/classes/_type_validatorprefs_.validatorprefs.md) -- [hidden](types/classes/_type_vestingschedule_.vestingschedule.md) -- [hidden](types/classes/_type_vote_.vote.md) -- [hidden](types/classes/_type_voteindex_.voteindex.md) -- [hidden](types/classes/_type_votethreshold_.votethreshold.md) diff --git a/docs/api-derive/README.md b/docs/api-derive/README.md deleted file mode 100644 index 233e5a0fb5..0000000000 --- a/docs/api-derive/README.md +++ /dev/null @@ -1,11 +0,0 @@ - -@polkadot/api-derive -==================== - -Common functions used across Polkadot, derived from RPC calls and storage queries. - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/api-derive/SUMMARY.html b/docs/api-derive/SUMMARY.html deleted file mode 100644 index 7dfd143c84..0000000000 --- a/docs/api-derive/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api
- - - diff --git a/docs/api-derive/SUMMARY.md b/docs/api-derive/SUMMARY.md deleted file mode 100644 index 4b1967de41..0000000000 --- a/docs/api-derive/SUMMARY.md +++ /dev/null @@ -1,28 +0,0 @@ -* ["accounts/idAndIndex"](modules/_accounts_idandindex_.md) -* ["accounts/idToIndex"](modules/_accounts_idtoindex_.md) -* ["accounts/indexToId"](modules/_accounts_indextoid_.md) -* ["accounts/indexes"](modules/_accounts_indexes_.md) -* ["balances/fees"](modules/_balances_fees_.md) -* ["balances/validatingBalance"](modules/_balances_validatingbalance_.md) -* ["balances/validatingBalances"](modules/_balances_validatingbalances_.md) -* ["balances/votingBalance"](modules/_balances_votingbalance_.md) -* ["balances/votingBalances"](modules/_balances_votingbalances_.md) -* ["balances/votingBalancesNominatorsFor"](modules/_balances_votingbalancesnominatorsfor_.md) -* ["chain/bestNumber"](modules/_chain_bestnumber_.md) -* ["chain/bestNumberFinalised"](modules/_chain_bestnumberfinalised_.md) -* ["chain/bestNumberLag"](modules/_chain_bestnumberlag_.md) -* ["chain/getHeader"](modules/_chain_getheader_.md) -* ["chain/subscribeNewHead"](modules/_chain_subscribenewhead_.md) -* ["democracy/referendumInfo"](modules/_democracy_referenduminfo_.md) - * [ReferendumInfoExtended](classes/_democracy_referenduminfo_.referenduminfoextended.md) -* ["democracy/referendumInfos"](modules/_democracy_referenduminfos_.md) -* ["democracy/referendumVotesFor"](modules/_democracy_referendumvotesfor_.md) -* ["democracy/referendums"](modules/_democracy_referendums_.md) -* ["democracy/votes"](modules/_democracy_votes_.md) -* ["session/eraLength"](modules/_session_eralength_.md) -* ["session/eraProgress"](modules/_session_eraprogress_.md) -* ["session/sessionProgress"](modules/_session_sessionprogress_.md) -* ["staking/intentionsBalances"](modules/_staking_intentionsbalances_.md) -* ["types"](modules/_types_.md) -* ["util/cache"](modules/_util_cache_.md) -* ["util/drr"](modules/_util_drr_.md) diff --git a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html b/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html deleted file mode 100644 index d2e607a23b..0000000000 --- a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ReferendumInfoExtended

description: A [[ReferendumInfo]] with an additional index field

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

ReferendumInfo

↳ ReferendumInfoExtended

Implements

  • Codec

Constructors

constructor

⊕ new ReferendumInfoExtended(value: ReferendumInfo | ReferendumInfoExtended, index?: BN | number): ReferendumInfoExtended

Overrides ReferendumInfo.__constructor

Defined in democracy/referendumInfo.ts:20

Parameters:

Name Type
value ReferendumInfo | ReferendumInfoExtended
Optional index BN | number

Returns: ReferendumInfoExtended

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

delay

get delay(): BlockNumber

Inherited from ReferendumInfo.delay

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58

description: The delay (in blocks) to wait after a successful referendum before deploying

Returns: BlockNumber

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

end

get end(): BlockNumber

Inherited from ReferendumInfo.end

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37

description: When voting on this referendum will end

Returns: BlockNumber

index

get index(): ReferendumIndex

Defined in democracy/referendumInfo.ts:33

description: Convenience getter, returns the referendumIndex

Returns: ReferendumIndex

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

proposal

get proposal(): Proposal

Inherited from ReferendumInfo.proposal

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44

description: The proposal being voted on

Returns: Proposal

threshold

get threshold(): VoteThreshold

Inherited from ReferendumInfo.threshold

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51

description: The thresholding mechanism to determine whether it passed

Returns: VoteThreshold

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Inherited from Struct.eq

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Inherited from Struct.toHex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Overrides Struct.toJSON

Defined in democracy/referendumInfo.ts:40

description: Creates the JSON representation

Returns: any

toString

▸ toString(): string

Inherited from Struct.toString

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md b/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md deleted file mode 100644 index 8e407d78c6..0000000000 --- a/docs/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.md +++ /dev/null @@ -1,512 +0,0 @@ - - -*__name__*: ReferendumInfoExtended - -*__description__*: A \[\[ReferendumInfo\]\] with an additional `index` field - -# Type parameters -#### S : `ConstructorDef` -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - - `ReferendumInfo` - -**↳ ReferendumInfoExtended** - -# Implements - -* `Codec` - -# Constructors - - - -## constructor - -⊕ **new ReferendumInfoExtended**(value: *`ReferendumInfo` \| [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md)*, index?: *`BN` \| `number`*): [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md) - -*Overrides ReferendumInfo.__constructor* - -*Defined in [democracy/referendumInfo.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L20)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `ReferendumInfo` \| [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md) | -| `Optional` index | `BN` \| `number` | - -**Returns:** [ReferendumInfoExtended](_democracy_referenduminfo_.referenduminfoextended.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from Struct.Type* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## delay - -**get delay**(): `BlockNumber` - -*Inherited from ReferendumInfo.delay* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L58)* - -*__description__*: The delay (in blocks) to wait after a successful referendum before deploying - -**Returns:** `BlockNumber` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from Struct.encodedLength* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## end - -**get end**(): `BlockNumber` - -*Inherited from ReferendumInfo.end* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L37)* - -*__description__*: When voting on this referendum will end - -**Returns:** `BlockNumber` - -___ - - -## index - -**get index**(): `ReferendumIndex` - -*Defined in [democracy/referendumInfo.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L33)* - -*__description__*: Convenience getter, returns the referendumIndex - -**Returns:** `ReferendumIndex` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from Struct.isEmpty* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## proposal - -**get proposal**(): `Proposal` - -*Inherited from ReferendumInfo.proposal* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L44)* - -*__description__*: The proposal being voted on - -**Returns:** `Proposal` - -___ - - -## threshold - -**get threshold**(): `VoteThreshold` - -*Inherited from ReferendumInfo.threshold* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L51)* - -*__description__*: The thresholding mechanism to determine whether it passed - -**Returns:** `VoteThreshold` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, `Codec`]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, `Codec`]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, `Codec`]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, `Codec`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Inherited from Struct.eq* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): `Codec` \| `undefined` - -*Inherited from Struct.get* - -*Overrides Map.get* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** `Codec` \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): `Codec` - -*Inherited from Struct.getAtIndex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `Codec` - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *`Codec`*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | `Codec` | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<`Codec`> - -*Inherited from Struct.toArray* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`Codec`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from Struct.toHex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Overrides Struct.toJSON* - -*Defined in [democracy/referendumInfo.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L40)* - -*__description__*: Creates the JSON representation - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from Struct.toString* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Inherited from Struct.toU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`Codec`> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<`Codec`> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `Constructor`<`Struct`<`S`>> - -*Inherited from Struct.with* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : `ConstructorDef` -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `Constructor`<`Struct`<`S`>> - -___ - diff --git a/docs/api-derive/index.html b/docs/api-derive/index.html deleted file mode 100644 index 2f66dd0cf0..0000000000 --- a/docs/api-derive/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_accounts_idandindex_.html b/docs/api-derive/modules/_accounts_idandindex_.html deleted file mode 100644 index 6c077d3000..0000000000 --- a/docs/api-derive/modules/_accounts_idandindex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_accounts_idandindex_.md b/docs/api-derive/modules/_accounts_idandindex_.md deleted file mode 100644 index 79371936b5..0000000000 --- a/docs/api-derive/modules/_accounts_idandindex_.md +++ /dev/null @@ -1,34 +0,0 @@ - - -# Type aliases - - - -## AccountIdAndIndex - -**Ƭ AccountIdAndIndex**: *[`undefined` \| `AccountId`, `undefined` \| `AccountIndex`]* - -*Defined in [accounts/idAndIndex.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/idAndIndex.ts#L16)* - -___ - -# Functions - - - -## idAndIndex - -▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [accounts/idAndIndex.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/idAndIndex.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_accounts_idtoindex_.html b/docs/api-derive/modules/_accounts_idtoindex_.html deleted file mode 100644 index a4a422497d..0000000000 --- a/docs/api-derive/modules/_accounts_idtoindex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_accounts_idtoindex_.md b/docs/api-derive/modules/_accounts_idtoindex_.md deleted file mode 100644 index 182d5cbdc4..0000000000 --- a/docs/api-derive/modules/_accounts_idtoindex_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## idToIndex - -▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/idToIndex.ts#L13)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_accounts_indexes_.html b/docs/api-derive/modules/_accounts_indexes_.html deleted file mode 100644 index c86d2d2096..0000000000 --- a/docs/api-derive/modules/_accounts_indexes_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_accounts_indexes_.md b/docs/api-derive/modules/_accounts_indexes_.md deleted file mode 100644 index 9ce239c096..0000000000 --- a/docs/api-derive/modules/_accounts_indexes_.md +++ /dev/null @@ -1,38 +0,0 @@ - - -# Type aliases - - - -## AccountIndexes - -**Ƭ AccountIndexes**: *`object`* - -*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/indexes.ts#L13)* - -#### Type declaration - -[index: `string`]: `AccountIndex` - -___ - -# Functions - - - -## indexes - -▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/indexes.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_accounts_indextoid_.html b/docs/api-derive/modules/_accounts_indextoid_.html deleted file mode 100644 index 2967fc7980..0000000000 --- a/docs/api-derive/modules/_accounts_indextoid_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_accounts_indextoid_.md b/docs/api-derive/modules/_accounts_indextoid_.md deleted file mode 100644 index c9a335716f..0000000000 --- a/docs/api-derive/modules/_accounts_indextoid_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## indexToId - -▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [accounts/indexToId.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/indexToId.ts#L13)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_balances_fees_.html b/docs/api-derive/modules/_balances_fees_.html deleted file mode 100644 index 9711d08d7f..0000000000 --- a/docs/api-derive/modules/_balances_fees_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_balances_fees_.md b/docs/api-derive/modules/_balances_fees_.md deleted file mode 100644 index 5868a73356..0000000000 --- a/docs/api-derive/modules/_balances_fees_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## fees - -▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/fees.ts#L13)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_balances_validatingbalance_.html b/docs/api-derive/modules/_balances_validatingbalance_.html deleted file mode 100644 index bec5f9b8be..0000000000 --- a/docs/api-derive/modules/_balances_validatingbalance_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_balances_validatingbalance_.md b/docs/api-derive/modules/_balances_validatingbalance_.md deleted file mode 100644 index 1ebd76b9df..0000000000 --- a/docs/api-derive/modules/_balances_validatingbalance_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## validatingBalance - -▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/validatingBalance.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_balances_validatingbalances_.html b/docs/api-derive/modules/_balances_validatingbalances_.html deleted file mode 100644 index 79dcfa0367..0000000000 --- a/docs/api-derive/modules/_balances_validatingbalances_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_balances_validatingbalances_.md b/docs/api-derive/modules/_balances_validatingbalances_.md deleted file mode 100644 index 71949dde3c..0000000000 --- a/docs/api-derive/modules/_balances_validatingbalances_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## validatingBalances - -▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/validatingBalances.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_balances_votingbalance_.html b/docs/api-derive/modules/_balances_votingbalance_.html deleted file mode 100644 index 3deda9b8dd..0000000000 --- a/docs/api-derive/modules/_balances_votingbalance_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_balances_votingbalance_.md b/docs/api-derive/modules/_balances_votingbalance_.md deleted file mode 100644 index 4b3eb48642..0000000000 --- a/docs/api-derive/modules/_balances_votingbalance_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## votingBalance - -▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/votingBalance.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_balances_votingbalances_.html b/docs/api-derive/modules/_balances_votingbalances_.html deleted file mode 100644 index 69296ca791..0000000000 --- a/docs/api-derive/modules/_balances_votingbalances_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_balances_votingbalances_.md b/docs/api-derive/modules/_balances_votingbalances_.md deleted file mode 100644 index d1f6d554d2..0000000000 --- a/docs/api-derive/modules/_balances_votingbalances_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## votingBalances - -▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/votingBalances.ts#L13)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.html b/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.html deleted file mode 100644 index d8522de071..0000000000 --- a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md b/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md deleted file mode 100644 index f80f6656e0..0000000000 --- a/docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## votingBalancesNominatorsFor - -▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_chain_bestnumber_.html b/docs/api-derive/modules/_chain_bestnumber_.html deleted file mode 100644 index 1081c43703..0000000000 --- a/docs/api-derive/modules/_chain_bestnumber_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_chain_bestnumber_.md b/docs/api-derive/modules/_chain_bestnumber_.md deleted file mode 100644 index 99000cb4e7..0000000000 --- a/docs/api-derive/modules/_chain_bestnumber_.md +++ /dev/null @@ -1,32 +0,0 @@ - - -# Functions - - - -## bestNumber - -▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/bestNumber.ts#L23)* - -*__description__*: Get the latest block number. - -*__example__*: - -```javascript -api.derive.chain.bestNumber((blockNumber) => { - console.log(`the current best block is #${blockNumber}`); -}); -``` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_chain_bestnumberfinalised_.html b/docs/api-derive/modules/_chain_bestnumberfinalised_.html deleted file mode 100644 index 05f48d1302..0000000000 --- a/docs/api-derive/modules/_chain_bestnumberfinalised_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_chain_bestnumberfinalised_.md b/docs/api-derive/modules/_chain_bestnumberfinalised_.md deleted file mode 100644 index 0d0a3fbeb9..0000000000 --- a/docs/api-derive/modules/_chain_bestnumberfinalised_.md +++ /dev/null @@ -1,30 +0,0 @@ - - -# Functions - - - -## bestNumberFinalised - -▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)* - -*__description__*: Get the latest finalised block number. example - -```javascript -api.derive.chain.bestNumberFinalised((blockNumber) => { - console.log(`the current finalised block is #${blockNumber}`); -}); -``` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_chain_bestnumberlag_.html b/docs/api-derive/modules/_chain_bestnumberlag_.html deleted file mode 100644 index 6cc1a7e9cc..0000000000 --- a/docs/api-derive/modules/_chain_bestnumberlag_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_chain_bestnumberlag_.md b/docs/api-derive/modules/_chain_bestnumberlag_.md deleted file mode 100644 index 37410c87d7..0000000000 --- a/docs/api-derive/modules/_chain_bestnumberlag_.md +++ /dev/null @@ -1,32 +0,0 @@ - - -# Functions - - - -## bestNumberLag - -▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/bestNumberLag.ts#L25)* - -*__description__*: Calculates the lag between finalised head and best head - -*__example__*: - -```javascript -api.derive.chain.bestNumberLag((lag) => { - console.log(`finalised is ${lag} blocks behind head`); -}); -``` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_chain_getheader_.html b/docs/api-derive/modules/_chain_getheader_.html deleted file mode 100644 index 9b4e7d00b5..0000000000 --- a/docs/api-derive/modules/_chain_getheader_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - -
polkadot-js/api

Functions

getHeader

▸ getHeader(api: ApiInterface$Rx): (Anonymous function)

Defined in chain/getHeader.ts:25

description: Get the a specific block header and extend it with the author

example:

const { author, blockNumber } = await api.derive.chain.getHeader('0x123...456');
-
-console.log(`block #${blockNumber} was authored by ${author}`);
-
1
2
3

Parameters:

Name Type
api ApiInterface$Rx

Returns: (Anonymous function)

- - - diff --git a/docs/api-derive/modules/_chain_getheader_.md b/docs/api-derive/modules/_chain_getheader_.md deleted file mode 100644 index 7143e8b46d..0000000000 --- a/docs/api-derive/modules/_chain_getheader_.md +++ /dev/null @@ -1,32 +0,0 @@ - - -# Functions - - - -## getHeader - -▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [chain/getHeader.ts:25](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/getHeader.ts#L25)* - -*__description__*: Get the a specific block header and extend it with the author - -*__example__*: - -```javascript -const { author, blockNumber } = await api.derive.chain.getHeader('0x123...456'); - -console.log(`block #${blockNumber} was authored by ${author}`); -``` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_chain_subscribenewhead_.html b/docs/api-derive/modules/_chain_subscribenewhead_.html deleted file mode 100644 index 8ae695033e..0000000000 --- a/docs/api-derive/modules/_chain_subscribenewhead_.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - -
polkadot-js/api

Type aliases

HeaderAndValidators

Ƭ HeaderAndValidators: [Header, Array<AccountId>]

Defined in chain/subscribeNewHead.ts:12

Functions

subscribeNewHead

▸ subscribeNewHead(api: ApiInterface$Rx): (Anonymous function)

Defined in chain/subscribeNewHead.ts:25

description: Subscribe to block headers and extend it with the author

example:

api.derive.chain.subscribeNewHead(({ author, blockNumber }) => {
-  console.log(`block #${blockNumber} was authored by ${author}`);
-});
-
1
2
3

Parameters:

Name Type
api ApiInterface$Rx

Returns: (Anonymous function)

- - - diff --git a/docs/api-derive/modules/_chain_subscribenewhead_.md b/docs/api-derive/modules/_chain_subscribenewhead_.md deleted file mode 100644 index af25520eb7..0000000000 --- a/docs/api-derive/modules/_chain_subscribenewhead_.md +++ /dev/null @@ -1,44 +0,0 @@ - - -# Type aliases - - - -## HeaderAndValidators - -**Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]* - -*Defined in [chain/subscribeNewHead.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/subscribeNewHead.ts#L12)* - -___ - -# Functions - - - -## subscribeNewHead - -▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [chain/subscribeNewHead.ts:25](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/subscribeNewHead.ts#L25)* - -*__description__*: Subscribe to block headers and extend it with the author - -*__example__*: - -```javascript -api.derive.chain.subscribeNewHead(({ author, blockNumber }) => { - console.log(`block #${blockNumber} was authored by ${author}`); -}); -``` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_democracy_referenduminfo_.html b/docs/api-derive/modules/_democracy_referenduminfo_.html deleted file mode 100644 index 2646d73125..0000000000 --- a/docs/api-derive/modules/_democracy_referenduminfo_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_democracy_referenduminfo_.md b/docs/api-derive/modules/_democracy_referenduminfo_.md deleted file mode 100644 index 0670dc7cce..0000000000 --- a/docs/api-derive/modules/_democracy_referenduminfo_.md +++ /dev/null @@ -1,34 +0,0 @@ - - -# Index - -### Classes - -* [ReferendumInfoExtended](../classes/_democracy_referenduminfo_.referenduminfoextended.md) - -### Functions - -* [referendumInfo](_democracy_referenduminfo_.md#referenduminfo) - ---- - -# Functions - - - -## referendumInfo - -▸ **referendumInfo**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [democracy/referendumInfo.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_democracy_referenduminfos_.html b/docs/api-derive/modules/_democracy_referenduminfos_.html deleted file mode 100644 index f47500a97e..0000000000 --- a/docs/api-derive/modules/_democracy_referenduminfos_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_democracy_referenduminfos_.md b/docs/api-derive/modules/_democracy_referenduminfos_.md deleted file mode 100644 index 29a6e8453e..0000000000 --- a/docs/api-derive/modules/_democracy_referenduminfos_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## referendumInfos - -▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfos.ts#L13)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_democracy_referendums_.html b/docs/api-derive/modules/_democracy_referendums_.html deleted file mode 100644 index 9fbecb3018..0000000000 --- a/docs/api-derive/modules/_democracy_referendums_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_democracy_referendums_.md b/docs/api-derive/modules/_democracy_referendums_.md deleted file mode 100644 index 2af2183b9e..0000000000 --- a/docs/api-derive/modules/_democracy_referendums_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## referendums - -▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [democracy/referendums.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendums.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_democracy_referendumvotesfor_.html b/docs/api-derive/modules/_democracy_referendumvotesfor_.html deleted file mode 100644 index fd0afb5367..0000000000 --- a/docs/api-derive/modules/_democracy_referendumvotesfor_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_democracy_referendumvotesfor_.md b/docs/api-derive/modules/_democracy_referendumvotesfor_.md deleted file mode 100644 index 7dcae9ed09..0000000000 --- a/docs/api-derive/modules/_democracy_referendumvotesfor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## referendumVotesFor - -▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [democracy/referendumVotesFor.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumVotesFor.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_democracy_votes_.html b/docs/api-derive/modules/_democracy_votes_.html deleted file mode 100644 index bf437cbc5e..0000000000 --- a/docs/api-derive/modules/_democracy_votes_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_democracy_votes_.md b/docs/api-derive/modules/_democracy_votes_.md deleted file mode 100644 index aa380c5deb..0000000000 --- a/docs/api-derive/modules/_democracy_votes_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## votes - -▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/votes.ts#L12)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_session_eralength_.html b/docs/api-derive/modules/_session_eralength_.html deleted file mode 100644 index 731512d180..0000000000 --- a/docs/api-derive/modules/_session_eralength_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_session_eralength_.md b/docs/api-derive/modules/_session_eralength_.md deleted file mode 100644 index 4a62aa208c..0000000000 --- a/docs/api-derive/modules/_session_eralength_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## eraLength - -▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/session/eraLength.ts#L13)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_session_eraprogress_.html b/docs/api-derive/modules/_session_eraprogress_.html deleted file mode 100644 index 79097cd8fd..0000000000 --- a/docs/api-derive/modules/_session_eraprogress_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_session_eraprogress_.md b/docs/api-derive/modules/_session_eraprogress_.md deleted file mode 100644 index 95d0dadbce..0000000000 --- a/docs/api-derive/modules/_session_eraprogress_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## eraProgress - -▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/session/eraProgress.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_session_sessionprogress_.html b/docs/api-derive/modules/_session_sessionprogress_.html deleted file mode 100644 index 2c44d38783..0000000000 --- a/docs/api-derive/modules/_session_sessionprogress_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_session_sessionprogress_.md b/docs/api-derive/modules/_session_sessionprogress_.md deleted file mode 100644 index 35eef0c34d..0000000000 --- a/docs/api-derive/modules/_session_sessionprogress_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## sessionProgress - -▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/session/sessionProgress.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_staking_intentionsbalances_.html b/docs/api-derive/modules/_staking_intentionsbalances_.html deleted file mode 100644 index e62f6151d6..0000000000 --- a/docs/api-derive/modules/_staking_intentionsbalances_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_staking_intentionsbalances_.md b/docs/api-derive/modules/_staking_intentionsbalances_.md deleted file mode 100644 index 1aa06ece14..0000000000 --- a/docs/api-derive/modules/_staking_intentionsbalances_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## intentionsBalances - -▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)` - -*Defined in [staking/intentionsBalances.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/staking/intentionsBalances.ts#L17)* - -Get the balances for all intentions and their nominators - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| api | `ApiInterface$Rx` | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_types_.html b/docs/api-derive/modules/_types_.html deleted file mode 100644 index 912c213046..0000000000 --- a/docs/api-derive/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_types_.md b/docs/api-derive/modules/_types_.md deleted file mode 100644 index 2542122c39..0000000000 --- a/docs/api-derive/modules/_types_.md +++ /dev/null @@ -1,51 +0,0 @@ - - -# Type aliases - - - -## DerivedBalances - -**Ƭ DerivedBalances**: *`object`* - -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L8)* - -#### Type declaration - -___ - - -## DerivedBalancesMap - -**Ƭ DerivedBalancesMap**: *`object`* - -*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L26)* - -#### Type declaration - -[index: `string`]: [DerivedBalances](_types_.md#derivedbalances) - -___ - - -## DerivedFees - -**Ƭ DerivedFees**: *`object`* - -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L18)* - -#### Type declaration - -___ - - -## DerivedReferendumVote - -**Ƭ DerivedReferendumVote**: *`object`* - -*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L30)* - -#### Type declaration - -___ - diff --git a/docs/api-derive/modules/_util_cache_.html b/docs/api-derive/modules/_util_cache_.html deleted file mode 100644 index 10be1ce9df..0000000000 --- a/docs/api-derive/modules/_util_cache_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_util_cache_.md b/docs/api-derive/modules/_util_cache_.md deleted file mode 100644 index 8cacbd2b76..0000000000 --- a/docs/api-derive/modules/_util_cache_.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# Functions - - - -## `` cache - -▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)` - -*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/util/cache.ts#L23)* - -Create memoization for a 2-currified function. - -**Parameters:** - -| Name | Type | Default value | Description | -| ------ | ------ | ------ | ------ | -| fn | `Function` | - | The function to memoize. | -| `Default value` map | `WeakMap`<`object`, `any`> | new WeakMap() | The Map used to cache function returns. | - -**Returns:** `(Anonymous function)` - -___ - diff --git a/docs/api-derive/modules/_util_drr_.html b/docs/api-derive/modules/_util_drr_.html deleted file mode 100644 index 6580e22934..0000000000 --- a/docs/api-derive/modules/_util_drr_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/api-derive/modules/_util_drr_.md b/docs/api-derive/modules/_util_drr_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/api-derive/modules/_util_drr_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/api/README.md b/docs/api/README.md deleted file mode 100644 index 0ad18c5cec..0000000000 --- a/docs/api/README.md +++ /dev/null @@ -1,107 +0,0 @@ - -@polkadot/api -============= - -The Polkadot-JS API provides easy-to-use wrappers around JSONRPC calls that flow from an application to a node. It handles all the encoding and decoding or parameters, provides access to RPC functions and allows for the query of chain state and the submission of transactions. - -The API wrappers provide a standard interface for use - - -* A static `.create()` that returns an API instance when connected, decorated and ready-to use. ApiOptions can include an optional WsProvider and optional custom type definitions `{ provider: , types: }`. -* The above is just a wrapper for `new Api()`, exposing the `isReady` getter -* `api.rpc.
.` provides access to actual RPC calls, be it for queries, submission or retrieving chain information - * [RPC (node interface)](../METHODS_RPC.md) -* `api.query.
.` provides access to chain state queries. These are dynamically populated based on what the runtime provides - * [Storage chain state (runtime node interface)](../METHODS_STORAGE.md) -* `api.tx.
.` provides the ability to create a transaction, like chain state, this list is populated from a runtime query - * [Extrinsics (runtime node interface)](../METHODS_EXTRINSICS.md) - -API Selection -------------- - -There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using [RxJS](https://github.com/ReactiveX/rxjs). Depending on your use-case and familiarity, you can choose either (or even both) for your application. - -* [ApiPromise](classes/_promise_api_.apipromise.md) All interface calls returns Promises, including the static `.create(...)`. Additionally any subscription method uses `(value) => {}` callbacks, returning the value as the subscription is updated. -* [ApiRx](classes/_rx_api_.apirx.md) All interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion subscription-based methods return long-running Observables that update with the latest values. - -Dynamic by default ------------------- - -Substrate (upon which Polkadot is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain. - -Due to this dynamic nature, this API departs from traditional APIs which only has fixed endpoints, driving use by what is available by the runtime. As a start, this generic nature has a learning curve, although the provided documentation, examples and linked documentation tries to make that experience as seamless as possible. - -Installation & import ---------------------- - -Installation - - -``` -npm install --save @polkadot/api -``` - -Subscribing to blocks via Promise-based API - - -```javascript -import { ApiPromise } from '@polkadot/api'; - -// initialise via static create -const api = await ApiPromise.create(); - -// make a call to retrieve the current network head -api.rpc.chain.subscribeNewHead((header) => { - console.log(`Chain is at #${header.blockNumber}`); -}); -``` - -Subscribing to blocks via RxJS-based API - - -```javascript -import { ApiRx } from '@polkadot/api'; - -// initialise via static create -const api = await ApiRx.create().toPromise(); - -// make a call to retrieve the current network head -api.rpc.chain.subscribeNewHead().subscribe((header) => { - console.log(`Chain is at #${header.blockNumber}`); -}); -``` - -Registering custom types ------------------------- - -Additional types used by runtime modules can be added when a new instance of the API is created. This is necessary if the runtime modules use types which are not available in the base Substrate runtime. - -```javascript -import { ApiPromise } from '@polkadot/api'; - -// initialise via static create and register custom types -const api = await ApiPromise.create({ - types: { - CustomTypesExample: { - "id": "u32", - "data": "Vec", - "deposit": "Balance", - "owner": "AccountId", - "application_expiry": "Moment", - "whitelisted": "bool", - "challenge_id": "u32" - } - } -}); -``` - -Users ------ - -Some of the users of the API (let us know if you are missing from the list), include - - -* [Polkadot-JS UI](https://github.com/polkadot-js/apps) A user-interface that allows you to make transactions, query the network or participate in actions on the network such as referendums and staking -* [Polkabot](https://gitlab.com/Polkabot) Polkabot is a Matrix chatbot that keeps an eye on the Polkadot network. You can see Polkabot in action in [https://matrix.to/#/#polkadot-network-status:matrix.org](https://matrix.to/#/#polkadot-network-status:matrix.org) -* [Polkawallet.io](https://polkawallet.io) and [Polkawallet (Github)](https://github.com/polkawallet-io/polkawallet-RN/) A mobile wallet for the Polkadot network to manage funds and make transactions, available on both Androind and iOS - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/api/SUMMARY.html b/docs/api/SUMMARY.html deleted file mode 100644 index 28bfa9d7b1..0000000000 --- a/docs/api/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/SUMMARY.md b/docs/api/SUMMARY.md deleted file mode 100644 index 38bf6b8a12..0000000000 --- a/docs/api/SUMMARY.md +++ /dev/null @@ -1,35 +0,0 @@ -* ["Base"](modules/_base_.md) - * [ApiBase](classes/_base_.apibase.md) -* ["SubmittableExtrinsic"](modules/_submittableextrinsic_.md) - * [SubmittableExtrinsic](classes/_submittableextrinsic_.submittableextrinsic.md) - * [SubmittableResult](classes/_submittableextrinsic_.submittableresult.md) -* ["checkTypes.manual"](modules/_checktypes_manual_.md) -* ["promise/Api"](modules/_promise_api_.md) - * [ApiPromise](classes/_promise_api_.apipromise.md) -* ["promise/Combinator"](modules/_promise_combinator_.md) - * [Combinator](classes/_promise_combinator_.combinator.md) -* ["promise/types"](modules/_promise_types_.md) - * [ApiPromiseInterface](interfaces/_promise_types_.apipromiseinterface.md) -* ["rx/Api"](modules/_rx_api_.md) - * [ApiRx](classes/_rx_api_.apirx.md) -* ["rx/types"](modules/_rx_types_.md) - * [ApiRxInterface](interfaces/_rx_types_.apirxinterface.md) -* ["types"](modules/_types_.md) - * [ApiBaseInterface](interfaces/_types_.apibaseinterface.md) - * [ApiInterface$Decorated](interfaces/_types_.apiinterface_decorated.md) - * [ApiOptions](interfaces/_types_.apioptions.md) - * [DecoratedRpc](interfaces/_types_.decoratedrpc.md) - * [DecoratedRpc$Method](interfaces/_types_.decoratedrpc_method.md) - * [DecoratedRpc$Section](interfaces/_types_.decoratedrpc_section.md) - * [Derive](interfaces/_types_.derive.md) - * [DeriveMethodBase](interfaces/_types_.derivemethodbase.md) - * [DeriveSection](interfaces/_types_.derivesection.md) - * [QueryableModuleStorage](interfaces/_types_.queryablemodulestorage.md) - * [QueryableStorage](interfaces/_types_.queryablestorage.md) - * [QueryableStorageFunctionBase](interfaces/_types_.queryablestoragefunctionbase.md) - * [Signer](interfaces/_types_.signer.md) - * [SubmittableExtrinsicFunction](interfaces/_types_.submittableextrinsicfunction.md) - * [SubmittableExtrinsics](interfaces/_types_.submittableextrinsics.md) - * [SubmittableModuleExtrinsics](interfaces/_types_.submittablemoduleextrinsics.md) -* ["util/filterEvents"](modules/_util_filterevents_.md) -* ["util/logging"](modules/_util_logging_.md) diff --git a/docs/api/classes/_base_.apibase.html b/docs/api/classes/_base_.apibase.html deleted file mode 100644 index 9948c93214..0000000000 --- a/docs/api/classes/_base_.apibase.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

CodecResult

SubscriptionResult

Hierarchy

ApiBase

↳ ApiRxInterface

↳ ApiPromiseInterface

↳ ApiPromise

↳ ApiRx

Implements

Constructors

constructor

⊕ new ApiBase(provider?: ApiOptions | ProviderInterface, type: ApiType): ApiBase

Defined in Base.ts:81

description: Create an instance of the class

example:

import Api from '@polkadot/api/promise';
-
-const api = new Api().isReady();
-
-api.rpc.subscribeNewHead((header) => {
-  console.log(`new block #${header.blockNumber.toNumber()}`);
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value
Default value provider ApiOptions | ProviderInterface {}
type ApiType -

Returns: ApiBase

Accessors

derive

get derive(): Derive<CodecResult, SubscriptionResult>

Defined in Base.ts:196

description: Derived results that are injected into the API, allowing for combinations of various query results.

example:

api.derive.chain.bestNumber((number) => {
-  console.log('best number', number);
-});
-
1
2
3

Returns: Derive<CodecResult, SubscriptionResult>

genesisHash

get genesisHash(): Hash

Defined in Base.ts:132

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash

hasSubscriptions

get hasSubscriptions(): boolean

Defined in Base.ts:141

description: true when subscriptions are supported

Returns: boolean

libraryInfo

get libraryInfo(): string

Defined in Base.ts:148

description: The library information name & version (from package.json)

Returns: string

query

get query(): QueryableStorage<CodecResult, SubscriptionResult>

Defined in Base.ts:216

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

api.query.balances.freeBalance(<accountId>, (balance) => {
-  console.log('new balance', balance);
-});
-
1
2
3

Returns: QueryableStorage<CodecResult, SubscriptionResult>

rpc

get rpc(): DecoratedRpc<CodecResult, SubscriptionResult>

Defined in Base.ts:236

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

api.rpc.chain.subscribeNewHead((header) => {
-  console.log('new header', header);
-});
-
1
2
3

Returns: DecoratedRpc<CodecResult, SubscriptionResult>

runtimeMetadata

get runtimeMetadata(): Metadata

Defined in Base.ts:155

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: Metadata

runtimeVersion

get runtimeVersion(): RuntimeVersion

Defined in Base.ts:164

description: Contains the version information for the current runtime.

Returns: RuntimeVersion

tx

get tx(): SubmittableExtrinsics<CodecResult, SubscriptionResult>

Defined in Base.ts:254

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
-  .transfer(<recipientId>, <balance>)
-  .signAndSend(<keyPair>, ({status}) => {
-    console.log('tx status', status.asFinalised.toHex());
-  });
-
1
2
3
4
5

Returns: SubmittableExtrinsics<CodecResult, SubscriptionResult>

type

get type(): ApiType

Defined in Base.ts:173

description: The type of this API instance, either 'rxjs' or 'promise'

Returns: ApiType

Methods

disconnect

▸ disconnect(): void

Defined in Base.ts:263

description: Disconnect from the underlying provider, halting all comms

Returns: void

on

▸ on(type: ApiInterface$Events, handler: function): this

Defined in Base.ts:286

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.on('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

once

▸ once(type: ApiInterface$Events, handler: function): this

Defined in Base.ts:311

description: Attach an one-time eventemitter handler to listen to a specific event

example:

api.once('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.once('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

registerTypes

▸ registerTypes(types?: RegistryTypes): void

Defined in Base.ts:320

description: Register additional user-defined of chain-specific types in the type registry

Parameters:

Name Type
Optional types RegistryTypes

Returns: void

setSigner

▸ setSigner(signer: Signer): void

Defined in Base.ts:180

description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair

Parameters:

Name Type
signer Signer

Returns: void

- - - diff --git a/docs/api/classes/_base_.apibase.md b/docs/api/classes/_base_.apibase.md deleted file mode 100644 index aa329f38f4..0000000000 --- a/docs/api/classes/_base_.apibase.md +++ /dev/null @@ -1,345 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**ApiBase** - -↳ [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md) - -↳ [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md) - -↳ [ApiPromise](_promise_api_.apipromise.md) - -↳ [ApiRx](_rx_api_.apirx.md) - -# Implements - -* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md)<`CodecResult`, `SubscriptionResult`> - -# Constructors - - - -## constructor - -⊕ **new ApiBase**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiBase](_base_.apibase.md) - -*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L81)* - -*__description__*: Create an instance of the class - -*__example__*: - -```javascript -import Api from '@polkadot/api/promise'; - -const api = new Api().isReady(); - -api.rpc.subscribeNewHead((header) => { - console.log(`new block #${header.blockNumber.toNumber()}`); -}); -``` - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` provider | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | {} | -| type | [ApiType](../modules/_types_.md#apitype) | - | - -**Returns:** [ApiBase](_base_.apibase.md) - -___ - -# Accessors - - - -## derive - -**get derive**(): [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`> - -*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196)* - -*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. - -*__example__*: - -```javascript -api.derive.chain.bestNumber((number) => { - console.log('best number', number); -}); -``` - -**Returns:** [Derive](../interfaces/_types_.derive.md)<`CodecResult`, `SubscriptionResult`> - -___ - - -## genesisHash - -**get genesisHash**(): `Hash` - -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132)* - -*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. - -**Returns:** `Hash` - -___ - - -## hasSubscriptions - -**get hasSubscriptions**(): `boolean` - -*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141)* - -*__description__*: `true` when subscriptions are supported - -**Returns:** `boolean` - -___ - - -## libraryInfo - -**get libraryInfo**(): `string` - -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148)* - -*__description__*: The library information name & version (from package.json) - -**Returns:** `string` - -___ - - -## query - -**get query**(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`> - -*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216)* - -*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. - -All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.query.timestamp.now()` (current block timestamp) does not take parameters, while `api.query.system.accountNonce()` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter. - -*__example__*: - -```javascript -api.query.balances.freeBalance(, (balance) => { - console.log('new balance', balance); -}); -``` - -**Returns:** [QueryableStorage](../interfaces/_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`> - -___ - - -## rpc - -**get rpc**(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`> - -*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236)* - -*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. - -RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions. - -*__example__*: - -```javascript -api.rpc.chain.subscribeNewHead((header) => { - console.log('new header', header); -}); -``` - -**Returns:** [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`> - -___ - - -## runtimeMetadata - -**get runtimeMetadata**(): `Metadata` - -*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155)* - -*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. - -**Returns:** `Metadata` - -___ - - -## runtimeVersion - -**get runtimeVersion**(): `RuntimeVersion` - -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164)* - -*__description__*: Contains the version information for the current runtime. - -**Returns:** `RuntimeVersion` - -___ - - -## tx - -**get tx**(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`> - -*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254)* - -*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. - -*__example__*: - -```javascript -api.tx.balances - .transfer(, ) - .signAndSend(, ({status}) => { - console.log('tx status', status.asFinalised.toHex()); - }); -``` - -**Returns:** [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`> - -___ - - -## type - -**get type**(): [ApiType](../modules/_types_.md#apitype) - -*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173)* - -*__description__*: The type of this API instance, either 'rxjs' or 'promise' - -**Returns:** [ApiType](../modules/_types_.md#apitype) - -___ - -# Methods - - - -## disconnect - -▸ **disconnect**(): `void` - -*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263)* - -*__description__*: Disconnect from the underlying provider, halting all comms - -**Returns:** `void` - -___ - - -## on - -▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286)* - -*__description__*: Attach an eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.on('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.on('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## once - -▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311)* - -*__description__*: Attach an one-time eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.once('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.once('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## registerTypes - -▸ **registerTypes**(types?: *`RegistryTypes`*): `void` - -*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320)* - -*__description__*: Register additional user-defined of chain-specific types in the type registry - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` types | `RegistryTypes` | - -**Returns:** `void` - -___ - - -## setSigner - -▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void` - -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180)* - -*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signer | [Signer](../interfaces/_types_.signer.md) | - -**Returns:** `void` - -___ - diff --git a/docs/api/classes/_promise_api_.apipromise.html b/docs/api/classes/_promise_api_.apipromise.html deleted file mode 100644 index 6f245c4c88..0000000000 --- a/docs/api/classes/_promise_api_.apipromise.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/api/promise

Overview

name: ApiPromise

description: ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static .create(...). Subscription calls utilise (value) => {} callbacks to pass through the latest values.

The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.

see: ApiRx

Usage

Making rpc calls -

import ApiPromise from '@polkadot/api/promise';
-
-// initialise via static create
-const api = await ApiPromise.create();
-
-// make a subscription to the network head
-api.rpc.chain.subscribeNewHead((header) => {
-  console.log(`Chain is at #${header.blockNumber}`);
-});
-
1
2
3
4
5
6
7
8
9

Subscribing to chain state -

import { ApiPromise, WsProvider } from '@polkadot/api';
-
-// initialise a provider with a specific endpoint
-const provider = new WsProvider('wss://example.com:9944')
-
-// initialise via isReady & new with specific provider
-const api = await new ApiPromise(provider).isReady;
-
-// retrieve the block target time
-const blockPeriod = await api.query.timestamp.blockPeriod().toNumber();
-let last = 0;
-
-// subscribe to the current block timestamp, updates automatically (callback provided)
-api.query.timestamp.now((timestamp) => {
-  const elapsed = last
-    ? `, ${timestamp.toNumber() - last}s since last`
-    : '';
-
-  last = timestamp.toNumber();
-  console.log(`timestamp ${timestamp}${elapsed} (${blockPeriod}s target)`);
-});
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Submitting a transaction -

import ApiPromise from '@polkadot/api/promise';
-
-ApiPromise.create().then((api) => {
-  const nonce = await api.query.system.accountNonce(keyring.alice.address());
-
-  api.tx.balances
-    // create transfer
-    transfer(keyring.bob.address(), 12345)
-    // sign the transcation
-    .sign(keyring.alice, { nonce })
-    // send the transaction (optional status callback)
-    .send((status) => {
-      console.log(`current status ${status.type}`);
-    })
-    // retrieve the submitted extrinsic hash
-    .then((hash) => {
-      console.log(`submitted with hash ${hash}`);
-    });
-});
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

Hierarchy

ApiBase<CodecResult, SubscriptionResult>

↳ ApiPromise

Implements

Constructors

constructor

⊕ new ApiPromise(options?: ApiOptions | ProviderInterface): ApiPromise

Overrides ApiBase.constructor

Defined in promise/Api.ts:127

description: Creates an instance of the ApiPromise class

example:

import Api from '@polkadot/api/promise';
-
-new Api().isReady.then((api) => {
-  api.rpc.subscribeNewHead((header) => {
-    console.log(`new block #${header.blockNumber.toNumber()}`);
-  });
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
Optional options ApiOptions | ProviderInterface Options to create an instance. This can be either ApiOptions or an [[WsProvider]].

Returns: ApiPromise

Accessors

derive

get derive(): Derive<CodecResult, SubscriptionResult>

Inherited from ApiBase.derive

Defined in Base.ts:196

description: Derived results that are injected into the API, allowing for combinations of various query results.

example:

api.derive.chain.bestNumber((number) => {
-  console.log('best number', number);
-});
-
1
2
3

Returns: Derive<CodecResult, SubscriptionResult>

genesisHash

get genesisHash(): Hash

Inherited from ApiBase.genesisHash

Defined in Base.ts:132

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash

hasSubscriptions

get hasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

Defined in Base.ts:141

description: true when subscriptions are supported

Returns: boolean

isReady

get isReady(): Promise<ApiPromise>

Defined in promise/Api.ts:161

description: Promise that returns the first time we are connected and loaded

Returns: Promise<ApiPromise>

libraryInfo

get libraryInfo(): string

Inherited from ApiBase.libraryInfo

Defined in Base.ts:148

description: The library information name & version (from package.json)

Returns: string

query

get query(): QueryableStorage<CodecResult, SubscriptionResult>

Inherited from ApiBase.query

Defined in Base.ts:216

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

api.query.balances.freeBalance(<accountId>, (balance) => {
-  console.log('new balance', balance);
-});
-
1
2
3

Returns: QueryableStorage<CodecResult, SubscriptionResult>

rpc

get rpc(): DecoratedRpc<CodecResult, SubscriptionResult>

Inherited from ApiBase.rpc

Defined in Base.ts:236

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

api.rpc.chain.subscribeNewHead((header) => {
-  console.log('new header', header);
-});
-
1
2
3

Returns: DecoratedRpc<CodecResult, SubscriptionResult>

runtimeMetadata

get runtimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

Defined in Base.ts:155

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: Metadata

runtimeVersion

get runtimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

Defined in Base.ts:164

description: Contains the version information for the current runtime.

Returns: RuntimeVersion

tx

get tx(): SubmittableExtrinsics<CodecResult, SubscriptionResult>

Inherited from ApiBase.tx

Defined in Base.ts:254

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
-  .transfer(<recipientId>, <balance>)
-  .signAndSend(<keyPair>, ({status}) => {
-    console.log('tx status', status.asFinalised.toHex());
-  });
-
1
2
3
4
5

Returns: SubmittableExtrinsics<CodecResult, SubscriptionResult>

type

get type(): ApiType

Inherited from ApiBase.type

Defined in Base.ts:173

description: The type of this API instance, either 'rxjs' or 'promise'

Returns: ApiType

Methods

clone

▸ clone(): ApiPromise

Defined in promise/Api.ts:168

description: Returns a clone of this ApiPromise instance (new underlying provider connection)

Returns: ApiPromise

combineLatest

▸ combineLatest(fns: Array<CombinatorFunction | [CombinatorFunction, Array]>, callback: CombinatorCallback): SubscriptionResult

Defined in promise/Api.ts:195

description: Creates a combinator that can be used to combine the latest results from multiple subscriptions

example:

const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7';
-
-// combines values from balance & nonce as it updates
-api.combineLatest([
-  api.rpc.chain.subscribeNewHead,
-  [api.query.balances.freeBalance, address],
-  (cb) => api.query.system.accountNonce(address, cb)
-], ([head, balance, nonce]) => {
-  console.log(`#${head.number}: You have ${balance} units, with ${nonce} transactions sent`);
-});
-
1
2
3
4
5
6
7
8
9
10

Parameters:

Name Type Description
fns Array<CombinatorFunction | [CombinatorFunction, Array]> An array of function to combine, each in the form of `(cb: (value: void)) => void`
callback CombinatorCallback A callback that will return an Array of all the values this combinator has been applied to

Returns: SubscriptionResult

disconnect

▸ disconnect(): void

Implementation of ApiPromiseInterface.disconnect

Inherited from ApiBase.disconnect

Defined in Base.ts:263

description: Disconnect from the underlying provider, halting all comms

Returns: void

on

▸ on(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.on

Defined in Base.ts:286

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.on('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

once

▸ once(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.once

Defined in Base.ts:311

description: Attach an one-time eventemitter handler to listen to a specific event

example:

api.once('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.once('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

registerTypes

▸ registerTypes(types?: RegistryTypes): void

Implementation of ApiPromiseInterface.registerTypes

Inherited from ApiBase.registerTypes

Defined in Base.ts:320

description: Register additional user-defined of chain-specific types in the type registry

Parameters:

Name Type
Optional types RegistryTypes

Returns: void

setSigner

▸ setSigner(signer: Signer): void

Implementation of ApiPromiseInterface.setSigner

Inherited from ApiBase.setSigner

Defined in Base.ts:180

description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair

Parameters:

Name Type
signer Signer

Returns: void

<Static> create

▸ create(options?: ApiOptions | ProviderInterface): Promise<ApiPromise>

Defined in promise/Api.ts:125

description: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.

example:

import Api from '@polkadot/api/promise';
-
-Api.create().then(async (api) => {
-  const timestamp = await api.query.timestamp.now();
-
-  console.log(`lastest block timestamp ${timestamp}`);
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value Description
Default value options ApiOptions | ProviderInterface {} options that is passed to the class contructor. Can be either ApiOptions or a provider (see the constructor arguments)

Returns: Promise<ApiPromise>

- - - diff --git a/docs/api/classes/_promise_api_.apipromise.md b/docs/api/classes/_promise_api_.apipromise.md deleted file mode 100644 index 0f85c726cc..0000000000 --- a/docs/api/classes/_promise_api_.apipromise.md +++ /dev/null @@ -1,551 +0,0 @@ - - -@polkadot/api/promise -===================== - -Overview --------- - -*__name__*: ApiPromise - -*__description__*: ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static `.create(...)`. Subscription calls utilise `(value) => {}` callbacks to pass through the latest values. - -The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients. - -*__see__*: [ApiRx](_rx_api_.apirx.md) - -Usage ------ - -Making rpc calls - - -```javascript -import ApiPromise from '@polkadot/api/promise'; - -// initialise via static create -const api = await ApiPromise.create(); - -// make a subscription to the network head -api.rpc.chain.subscribeNewHead((header) => { - console.log(`Chain is at #${header.blockNumber}`); -}); -``` - - - -Subscribing to chain state - - -```javascript -import { ApiPromise, WsProvider } from '@polkadot/api'; - -// initialise a provider with a specific endpoint -const provider = new WsProvider('wss://example.com:9944') - -// initialise via isReady & new with specific provider -const api = await new ApiPromise(provider).isReady; - -// retrieve the block target time -const blockPeriod = await api.query.timestamp.blockPeriod().toNumber(); -let last = 0; - -// subscribe to the current block timestamp, updates automatically (callback provided) -api.query.timestamp.now((timestamp) => { - const elapsed = last - ? `, ${timestamp.toNumber() - last}s since last` - : ''; - - last = timestamp.toNumber(); - console.log(`timestamp ${timestamp}${elapsed} (${blockPeriod}s target)`); -}); -``` - - - -Submitting a transaction - - -```javascript -import ApiPromise from '@polkadot/api/promise'; - -ApiPromise.create().then((api) => { - const nonce = await api.query.system.accountNonce(keyring.alice.address()); - - api.tx.balances - // create transfer - transfer(keyring.bob.address(), 12345) - // sign the transcation - .sign(keyring.alice, { nonce }) - // send the transaction (optional status callback) - .send((status) => { - console.log(`current status ${status.type}`); - }) - // retrieve the submitted extrinsic hash - .then((hash) => { - console.log(`submitted with hash ${hash}`); - }); -}); -``` - -# Hierarchy - - [ApiBase](_base_.apibase.md)<[CodecResult](), [SubscriptionResult]()> - -**↳ ApiPromise** - -# Implements - -* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md)<[CodecResult](), [SubscriptionResult]()> -* [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md) - -# Constructors - - - -## constructor - -⊕ **new ApiPromise**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): [ApiPromise](_promise_api_.apipromise.md) - -*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* - -*Defined in [promise/Api.ts:127](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L127)* - -*__description__*: Creates an instance of the ApiPromise class - -*__example__*: - -```javascript -import Api from '@polkadot/api/promise'; - -new Api().isReady.then((api) => { - api.rpc.subscribeNewHead((header) => { - console.log(`new block #${header.blockNumber.toNumber()}`); - }); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | Options to create an instance. This can be either [ApiOptions](../interfaces/_types_.apioptions.md) or an \[\[WsProvider\]\]. | - -**Returns:** [ApiPromise](_promise_api_.apipromise.md) - -___ - -# Accessors - - - -## derive - -**get derive**(): [Derive](../interfaces/_types_.derive.md)<[CodecResult](), [SubscriptionResult]()> - -*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* - -*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196)* - -*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. - -*__example__*: - -```javascript -api.derive.chain.bestNumber((number) => { - console.log('best number', number); -}); -``` - -**Returns:** [Derive](../interfaces/_types_.derive.md)<[CodecResult](), [SubscriptionResult]()> - -___ - - -## genesisHash - -**get genesisHash**(): `Hash` - -*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132)* - -*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. - -**Returns:** `Hash` - -___ - - -## hasSubscriptions - -**get hasSubscriptions**(): `boolean` - -*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* - -*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141)* - -*__description__*: `true` when subscriptions are supported - -**Returns:** `boolean` - -___ - - -## isReady - -**get isReady**(): `Promise`<[ApiPromise](_promise_api_.apipromise.md)> - -*Defined in [promise/Api.ts:161](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L161)* - -*__description__*: Promise that returns the first time we are connected and loaded - -**Returns:** `Promise`<[ApiPromise](_promise_api_.apipromise.md)> - -___ - - -## libraryInfo - -**get libraryInfo**(): `string` - -*Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)* - -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148)* - -*__description__*: The library information name & version (from package.json) - -**Returns:** `string` - -___ - - -## query - -**get query**(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[CodecResult](), [SubscriptionResult]()> - -*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* - -*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216)* - -*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. - -All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.query.timestamp.now()` (current block timestamp) does not take parameters, while `api.query.system.accountNonce()` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter. - -*__example__*: - -```javascript -api.query.balances.freeBalance(, (balance) => { - console.log('new balance', balance); -}); -``` - -**Returns:** [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[CodecResult](), [SubscriptionResult]()> - -___ - - -## rpc - -**get rpc**(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[CodecResult](), [SubscriptionResult]()> - -*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* - -*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236)* - -*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. - -RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions. - -*__example__*: - -```javascript -api.rpc.chain.subscribeNewHead((header) => { - console.log('new header', header); -}); -``` - -**Returns:** [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[CodecResult](), [SubscriptionResult]()> - -___ - - -## runtimeMetadata - -**get runtimeMetadata**(): `Metadata` - -*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* - -*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155)* - -*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. - -**Returns:** `Metadata` - -___ - - -## runtimeVersion - -**get runtimeVersion**(): `RuntimeVersion` - -*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* - -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164)* - -*__description__*: Contains the version information for the current runtime. - -**Returns:** `RuntimeVersion` - -___ - - -## tx - -**get tx**(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<[CodecResult](), [SubscriptionResult]()> - -*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* - -*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254)* - -*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. - -*__example__*: - -```javascript -api.tx.balances - .transfer(, ) - .signAndSend(, ({status}) => { - console.log('tx status', status.asFinalised.toHex()); - }); -``` - -**Returns:** [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<[CodecResult](), [SubscriptionResult]()> - -___ - - -## type - -**get type**(): [ApiType](../modules/_types_.md#apitype) - -*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* - -*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173)* - -*__description__*: The type of this API instance, either 'rxjs' or 'promise' - -**Returns:** [ApiType](../modules/_types_.md#apitype) - -___ - -# Methods - - - -## clone - -▸ **clone**(): [ApiPromise](_promise_api_.apipromise.md) - -*Defined in [promise/Api.ts:168](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L168)* - -*__description__*: Returns a clone of this ApiPromise instance (new underlying provider connection) - -**Returns:** [ApiPromise](_promise_api_.apipromise.md) - -___ - - -## combineLatest - -▸ **combineLatest**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [SubscriptionResult]() - -*Defined in [promise/Api.ts:195](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L195)* - -*__description__*: Creates a combinator that can be used to combine the latest results from multiple subscriptions - -*__example__*: - -```javascript -const address = '5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7'; - -// combines values from balance & nonce as it updates -api.combineLatest([ - api.rpc.chain.subscribeNewHead, - [api.query.balances.freeBalance, address], - (cb) => api.query.system.accountNonce(address, cb) -], ([head, balance, nonce]) => { - console.log(`#${head.number}: You have ${balance} units, with ${nonce} transactions sent`); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| fns | `Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]> | An array of function to combine, each in the form of \`(cb: (value: void)) => void\` | -| callback | [CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback) | A callback that will return an Array of all the values this combinator has been applied to | - -**Returns:** [SubscriptionResult]() - -___ - - -## disconnect - -▸ **disconnect**(): `void` - -*Implementation of [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md).[disconnect](../interfaces/_promise_types_.apipromiseinterface.md#disconnect)* - -*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* - -*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263)* - -*__description__*: Disconnect from the underlying provider, halting all comms - -**Returns:** `void` - -___ - - -## on - -▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* - -*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286)* - -*__description__*: Attach an eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.on('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.on('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## once - -▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* - -*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311)* - -*__description__*: Attach an one-time eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.once('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.once('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## registerTypes - -▸ **registerTypes**(types?: *`RegistryTypes`*): `void` - -*Implementation of [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md).[registerTypes](../interfaces/_promise_types_.apipromiseinterface.md#registertypes)* - -*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* - -*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320)* - -*__description__*: Register additional user-defined of chain-specific types in the type registry - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` types | `RegistryTypes` | - -**Returns:** `void` - -___ - - -## setSigner - -▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void` - -*Implementation of [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md).[setSigner](../interfaces/_promise_types_.apipromiseinterface.md#setsigner)* - -*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* - -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180)* - -*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signer | [Signer](../interfaces/_types_.signer.md) | - -**Returns:** `void` - -___ - - -## `` create - -▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Promise`<[ApiPromise](_promise_api_.apipromise.md)> - -*Defined in [promise/Api.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L125)* - -*__description__*: Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance. - -*__example__*: - -```javascript -import Api from '@polkadot/api/promise'; - -Api.create().then(async (api) => { - const timestamp = await api.query.timestamp.now(); - - console.log(`lastest block timestamp ${timestamp}`); -}); -``` - -**Parameters:** - -| Name | Type | Default value | Description | -| ------ | ------ | ------ | ------ | -| `Default value` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | {} | options that is passed to the class contructor. Can be either [ApiOptions](../interfaces/_types_.apioptions.md) or a provider (see the constructor arguments) | - -**Returns:** `Promise`<[ApiPromise](_promise_api_.apipromise.md)> - -___ - diff --git a/docs/api/classes/_promise_combinator_.combinator.html b/docs/api/classes/_promise_combinator_.combinator.html deleted file mode 100644 index cacc7818fe..0000000000 --- a/docs/api/classes/_promise_combinator_.combinator.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/classes/_promise_combinator_.combinator.md b/docs/api/classes/_promise_combinator_.combinator.md deleted file mode 100644 index 642cb8c631..0000000000 --- a/docs/api/classes/_promise_combinator_.combinator.md +++ /dev/null @@ -1,41 +0,0 @@ - - -# Hierarchy - -**Combinator** - -# Constructors - - - -## constructor - -⊕ **new Combinator**(fns: *`Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]>*, callback: *[CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback)*): [Combinator](_promise_combinator_.combinator.md) - -*Defined in [promise/Combinator.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L21)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| fns | `Array`<[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction) \| [[CombinatorFunction](../modules/_promise_combinator_.md#combinatorfunction), `Array`]> | -| callback | [CombinatorCallback](../modules/_promise_combinator_.md#combinatorcallback) | - -**Returns:** [Combinator](_promise_combinator_.combinator.md) - -___ - -# Methods - - - -## unsubscribe - -▸ **unsubscribe**(): `void` - -*Defined in [promise/Combinator.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L67)* - -**Returns:** `void` - -___ - diff --git a/docs/api/classes/_rx_api_.apirx.html b/docs/api/classes/_rx_api_.apirx.html deleted file mode 100644 index 0854cbecdf..0000000000 --- a/docs/api/classes/_rx_api_.apirx.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/api/rx

Overview

name: ApiRx

description: ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, all interface calls return RxJS Observables, including the static .create(...). In the same fashion and subscription-based methods return long-running Observables that update with the latest values.

The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding .subscribe and .pipe on Observables will unlock full-scale use thereof.

see: ApiPromise

Usage

Making rpc calls -

import ApiRx from '@polkadot/api/rx';
-
-// initialise via Promise & static create
-const api = await ApiRx.create().toPromise();
-
-// make a call to retrieve the current network head
-api.rpc.chain.subscribeNewHead().subscribe((header) => {
-  console.log(`Chain is at #${header.blockNumber}`);
-});
-
1
2
3
4
5
6
7
8
9

Subscribing to chain state -

import { combineLatest } from 'rxjs';
-import { pairwise, switchMap } from 'rxjs/operators';
-import { ApiRx, WsProvider } from '@polkadot/api';
-
-// initialise a provider with a specific endpoint
-const provider = new WsProvider('wss://example.com:9944')
-
-// initialise via isReady & new with specific provider
-new ApiRx(provider)
-  .isReady
-  .pipe(
-    switchMap((api) =>
-      combineLatest([
-        api.query.timestamp.blockPeriod(),
-        api.query.timestamp.now().pipe(pairwise())
-      ])
-    )
-  )
-  .subscribe(([blockPeriod, timestamp]) => {
-     const elapsed = timestamp[1].toNumber() - timestamp[0].toNumber();
-     console.log(`timestamp ${timestamp[1]} \nelapsed ${elapsed} \n(${blockPeriod}s target)`);
-  });
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

Submitting a transaction -

import { first, switchMap } from 'rxjs/operators';
-import ApiRx from '@polkadot/api/rx';
-
-// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
-import testingPairs from '@polkadot/keyring/testingPairs';
-const keyring = testingPairs();
-
-// get api via Promise
-const api = await ApiRx.create().toPromise();
-
-// retrieve nonce for the account
-api.query.system
-  .accountNonce(keyring.alice.address())
-  .pipe(
-     first(),
-     // pipe nonce into transfer
-     switchMap((nonce) =>
-       api.tx.balances
-         // create transfer
-         .transfer(keyring.bob.address(), 12345)
-         // sign the transcation
-         .sign(keyring.alice, { nonce })
-         // send the transaction
-         .send()
-     )
-  )
-  // subscribe to overall result
-  .subscribe(({ status, type }) => {
-    if (type === 'Finalised') {
-      console.log('Completed at block hash', status.asFinalised.toHex());
-    }
-  });
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

Hierarchy

ApiBase<RxResult, RxResult>

↳ ApiRx

Implements

Constructors

constructor

⊕ new ApiRx(provider?: ApiOptions | ProviderInterface): ApiRx

Overrides ApiBase.constructor

Defined in rx/Api.ts:141

description: Create an instance of the ApiRx class

example:

import { switchMap } from 'rxjs/operators';
-import Api from '@polkadot/api/rx';
-
-new Api().isReady
-  .pipe(
-    switchMap((api) =>
-      api.rpc.chain.subscribeNewHead()
-  ))
-  .subscribe((header) => {
-    console.log(`new block #${header.blockNumber.toNumber()}`);
-  });
-
1
2
3
4
5
6
7
8
9
10
11

Parameters:

Name Type
Optional provider ApiOptions | ProviderInterface

Returns: ApiRx

Accessors

derive

get derive(): Derive<RxResult, RxResult>

Inherited from ApiBase.derive

Defined in Base.ts:196

description: Derived results that are injected into the API, allowing for combinations of various query results.

example:

api.derive.chain.bestNumber((number) => {
-  console.log('best number', number);
-});
-
1
2
3

Returns: Derive<RxResult, RxResult>

genesisHash

get genesisHash(): Hash

Inherited from ApiBase.genesisHash

Defined in Base.ts:132

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash

hasSubscriptions

get hasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

Defined in Base.ts:141

description: true when subscriptions are supported

Returns: boolean

isConnected

get isConnected(): Observable<boolean>

Defined in rx/Api.ts:181

description: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.

Returns: Observable<boolean>

isReady

get isReady(): Observable<ApiRx>

Defined in rx/Api.ts:188

description: Observable that returns the first time we are connected and loaded

Returns: Observable<ApiRx>

libraryInfo

get libraryInfo(): string

Inherited from ApiBase.libraryInfo

Defined in Base.ts:148

description: The library information name & version (from package.json)

Returns: string

query

get query(): QueryableStorage<RxResult, RxResult>

Inherited from ApiBase.query

Defined in Base.ts:216

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

api.query.balances.freeBalance(<accountId>, (balance) => {
-  console.log('new balance', balance);
-});
-
1
2
3

Returns: QueryableStorage<RxResult, RxResult>

rpc

get rpc(): DecoratedRpc<RxResult, RxResult>

Inherited from ApiBase.rpc

Defined in Base.ts:236

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

api.rpc.chain.subscribeNewHead((header) => {
-  console.log('new header', header);
-});
-
1
2
3

Returns: DecoratedRpc<RxResult, RxResult>

runtimeMetadata

get runtimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

Defined in Base.ts:155

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: Metadata

runtimeVersion

get runtimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

Defined in Base.ts:164

description: Contains the version information for the current runtime.

Returns: RuntimeVersion

tx

get tx(): SubmittableExtrinsics<RxResult, RxResult>

Inherited from ApiBase.tx

Defined in Base.ts:254

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
-  .transfer(<recipientId>, <balance>)
-  .signAndSend(<keyPair>, ({status}) => {
-    console.log('tx status', status.asFinalised.toHex());
-  });
-
1
2
3
4
5

Returns: SubmittableExtrinsics<RxResult, RxResult>

type

get type(): ApiType

Inherited from ApiBase.type

Defined in Base.ts:173

description: The type of this API instance, either 'rxjs' or 'promise'

Returns: ApiType

Methods

clone

▸ clone(): ApiRx

Defined in rx/Api.ts:195

description: Returns a clone of this ApiRx instance (new underlying provider connection)

Returns: ApiRx

disconnect

▸ disconnect(): void

Implementation of ApiRxInterface.disconnect

Inherited from ApiBase.disconnect

Defined in Base.ts:263

description: Disconnect from the underlying provider, halting all comms

Returns: void

on

▸ on(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.on

Defined in Base.ts:286

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.on('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

once

▸ once(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.once

Defined in Base.ts:311

description: Attach an one-time eventemitter handler to listen to a specific event

example:

api.once('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.once('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

registerTypes

▸ registerTypes(types?: RegistryTypes): void

Implementation of ApiRxInterface.registerTypes

Inherited from ApiBase.registerTypes

Defined in Base.ts:320

description: Register additional user-defined of chain-specific types in the type registry

Parameters:

Name Type
Optional types RegistryTypes

Returns: void

setSigner

▸ setSigner(signer: Signer): void

Implementation of ApiRxInterface.setSigner

Inherited from ApiBase.setSigner

Defined in Base.ts:180

description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair

Parameters:

Name Type
signer Signer

Returns: void

<Static> create

▸ create(options?: ApiOptions | ProviderInterface): Observable<ApiRx>

Defined in rx/Api.ts:139

description: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.

example:

import { switchMap } from 'rxjs/operators';
-import Api from '@polkadot/api/rx';
-
-Api.create()
-  .pipe(
-    switchMap((api) =>
-      api.rpc.chain.subscribeNewHead()
-  ))
-  .subscribe((header) => {
-    console.log(`new block #${header.blockNumber.toNumber()}`);
-  });
-
1
2
3
4
5
6
7
8
9
10
11

Parameters:

Name Type Description
Optional options ApiOptions | ProviderInterface options that is passed to the class contructor. Can be either ApiOptions or [[WsProvider]]

Returns: Observable<ApiRx>

- - - diff --git a/docs/api/classes/_rx_api_.apirx.md b/docs/api/classes/_rx_api_.apirx.md deleted file mode 100644 index c15e458ead..0000000000 --- a/docs/api/classes/_rx_api_.apirx.md +++ /dev/null @@ -1,551 +0,0 @@ - - -@polkadot/api/rx -================ - -Overview --------- - -*__name__*: ApiRx - -*__description__*: ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, all interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion and subscription-based methods return long-running Observables that update with the latest values. - -The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof. - -*__see__*: [ApiPromise](_promise_api_.apipromise.md) - -Usage ------ - -Making rpc calls - - -```javascript -import ApiRx from '@polkadot/api/rx'; - -// initialise via Promise & static create -const api = await ApiRx.create().toPromise(); - -// make a call to retrieve the current network head -api.rpc.chain.subscribeNewHead().subscribe((header) => { - console.log(`Chain is at #${header.blockNumber}`); -}); -``` - - - -Subscribing to chain state - - -```javascript -import { combineLatest } from 'rxjs'; -import { pairwise, switchMap } from 'rxjs/operators'; -import { ApiRx, WsProvider } from '@polkadot/api'; - -// initialise a provider with a specific endpoint -const provider = new WsProvider('wss://example.com:9944') - -// initialise via isReady & new with specific provider -new ApiRx(provider) - .isReady - .pipe( - switchMap((api) => - combineLatest([ - api.query.timestamp.blockPeriod(), - api.query.timestamp.now().pipe(pairwise()) - ]) - ) - ) - .subscribe(([blockPeriod, timestamp]) => { - const elapsed = timestamp[1].toNumber() - timestamp[0].toNumber(); - console.log(`timestamp ${timestamp[1]} \nelapsed ${elapsed} \n(${blockPeriod}s target)`); - }); -``` - - - -Submitting a transaction - - -```javascript -import { first, switchMap } from 'rxjs/operators'; -import ApiRx from '@polkadot/api/rx'; - -// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie) -import testingPairs from '@polkadot/keyring/testingPairs'; -const keyring = testingPairs(); - -// get api via Promise -const api = await ApiRx.create().toPromise(); - -// retrieve nonce for the account -api.query.system - .accountNonce(keyring.alice.address()) - .pipe( - first(), - // pipe nonce into transfer - switchMap((nonce) => - api.tx.balances - // create transfer - .transfer(keyring.bob.address(), 12345) - // sign the transcation - .sign(keyring.alice, { nonce }) - // send the transaction - .send() - ) - ) - // subscribe to overall result - .subscribe(({ status, type }) => { - if (type === 'Finalised') { - console.log('Completed at block hash', status.asFinalised.toHex()); - } - }); -``` - -# Hierarchy - - [ApiBase](_base_.apibase.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -**↳ ApiRx** - -# Implements - -* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> -* [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md) - -# Constructors - - - -## constructor - -⊕ **new ApiRx**(provider?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): [ApiRx](_rx_api_.apirx.md) - -*Overrides [ApiBase](_base_.apibase.md).[constructor](_base_.apibase.md#constructor)* - -*Defined in [rx/Api.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L141)* - -*__description__*: Create an instance of the ApiRx class - -*__example__*: - -```javascript -import { switchMap } from 'rxjs/operators'; -import Api from '@polkadot/api/rx'; - -new Api().isReady - .pipe( - switchMap((api) => - api.rpc.chain.subscribeNewHead() - )) - .subscribe((header) => { - console.log(`new block #${header.blockNumber.toNumber()}`); - }); -``` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` provider | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | - -**Returns:** [ApiRx](_rx_api_.apirx.md) - -___ - -# Accessors - - - -## derive - -**get derive**(): [Derive](../interfaces/_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](_base_.apibase.md).[derive](_base_.apibase.md#derive)* - -*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196)* - -*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. - -*__example__*: - -```javascript -api.derive.chain.bestNumber((number) => { - console.log('best number', number); -}); -``` - -**Returns:** [Derive](../interfaces/_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## genesisHash - -**get genesisHash**(): `Hash` - -*Inherited from [ApiBase](_base_.apibase.md).[genesisHash](_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132)* - -*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. - -**Returns:** `Hash` - -___ - - -## hasSubscriptions - -**get hasSubscriptions**(): `boolean` - -*Inherited from [ApiBase](_base_.apibase.md).[hasSubscriptions](_base_.apibase.md#hassubscriptions)* - -*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141)* - -*__description__*: `true` when subscriptions are supported - -**Returns:** `boolean` - -___ - - -## isConnected - -**get isConnected**(): `Observable`<`boolean`> - -*Defined in [rx/Api.ts:181](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L181)* - -*__description__*: Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity. - -**Returns:** `Observable`<`boolean`> - -___ - - -## isReady - -**get isReady**(): `Observable`<[ApiRx](_rx_api_.apirx.md)> - -*Defined in [rx/Api.ts:188](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L188)* - -*__description__*: Observable that returns the first time we are connected and loaded - -**Returns:** `Observable`<[ApiRx](_rx_api_.apirx.md)> - -___ - - -## libraryInfo - -**get libraryInfo**(): `string` - -*Inherited from [ApiBase](_base_.apibase.md).[libraryInfo](_base_.apibase.md#libraryinfo)* - -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148)* - -*__description__*: The library information name & version (from package.json) - -**Returns:** `string` - -___ - - -## query - -**get query**(): [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](_base_.apibase.md).[query](_base_.apibase.md#query)* - -*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216)* - -*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. - -All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.query.timestamp.now()` (current block timestamp) does not take parameters, while `api.query.system.accountNonce()` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter. - -*__example__*: - -```javascript -api.query.balances.freeBalance(, (balance) => { - console.log('new balance', balance); -}); -``` - -**Returns:** [QueryableStorage](../interfaces/_types_.queryablestorage.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## rpc - -**get rpc**(): [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](_base_.apibase.md).[rpc](_base_.apibase.md#rpc)* - -*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236)* - -*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. - -RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions. - -*__example__*: - -```javascript -api.rpc.chain.subscribeNewHead((header) => { - console.log('new header', header); -}); -``` - -**Returns:** [DecoratedRpc](../interfaces/_types_.decoratedrpc.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## runtimeMetadata - -**get runtimeMetadata**(): `Metadata` - -*Inherited from [ApiBase](_base_.apibase.md).[runtimeMetadata](_base_.apibase.md#runtimemetadata)* - -*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155)* - -*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. - -**Returns:** `Metadata` - -___ - - -## runtimeVersion - -**get runtimeVersion**(): `RuntimeVersion` - -*Inherited from [ApiBase](_base_.apibase.md).[runtimeVersion](_base_.apibase.md#runtimeversion)* - -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164)* - -*__description__*: Contains the version information for the current runtime. - -**Returns:** `RuntimeVersion` - -___ - - -## tx - -**get tx**(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](_base_.apibase.md).[tx](_base_.apibase.md#tx)* - -*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254)* - -*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. - -*__example__*: - -```javascript -api.tx.balances - .transfer(, ) - .signAndSend(, ({status}) => { - console.log('tx status', status.asFinalised.toHex()); - }); -``` - -**Returns:** [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## type - -**get type**(): [ApiType](../modules/_types_.md#apitype) - -*Inherited from [ApiBase](_base_.apibase.md).[type](_base_.apibase.md#type)* - -*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173)* - -*__description__*: The type of this API instance, either 'rxjs' or 'promise' - -**Returns:** [ApiType](../modules/_types_.md#apitype) - -___ - -# Methods - - - -## clone - -▸ **clone**(): [ApiRx](_rx_api_.apirx.md) - -*Defined in [rx/Api.ts:195](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L195)* - -*__description__*: Returns a clone of this ApiRx instance (new underlying provider connection) - -**Returns:** [ApiRx](_rx_api_.apirx.md) - -___ - - -## disconnect - -▸ **disconnect**(): `void` - -*Implementation of [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md).[disconnect](../interfaces/_rx_types_.apirxinterface.md#disconnect)* - -*Inherited from [ApiBase](_base_.apibase.md).[disconnect](_base_.apibase.md#disconnect)* - -*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263)* - -*__description__*: Disconnect from the underlying provider, halting all comms - -**Returns:** `void` - -___ - - -## on - -▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](_base_.apibase.md).[on](_base_.apibase.md#on)* - -*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286)* - -*__description__*: Attach an eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.on('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.on('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## once - -▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](_base_.apibase.md).[once](_base_.apibase.md#once)* - -*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311)* - -*__description__*: Attach an one-time eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.once('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.once('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## registerTypes - -▸ **registerTypes**(types?: *`RegistryTypes`*): `void` - -*Implementation of [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md).[registerTypes](../interfaces/_rx_types_.apirxinterface.md#registertypes)* - -*Inherited from [ApiBase](_base_.apibase.md).[registerTypes](_base_.apibase.md#registertypes)* - -*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320)* - -*__description__*: Register additional user-defined of chain-specific types in the type registry - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` types | `RegistryTypes` | - -**Returns:** `void` - -___ - - -## setSigner - -▸ **setSigner**(signer: *[Signer](../interfaces/_types_.signer.md)*): `void` - -*Implementation of [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md).[setSigner](../interfaces/_rx_types_.apirxinterface.md#setsigner)* - -*Inherited from [ApiBase](_base_.apibase.md).[setSigner](_base_.apibase.md#setsigner)* - -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180)* - -*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signer | [Signer](../interfaces/_types_.signer.md) | - -**Returns:** `void` - -___ - - -## `` create - -▸ **create**(options?: *[ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface`*): `Observable`<[ApiRx](_rx_api_.apirx.md)> - -*Defined in [rx/Api.ts:139](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L139)* - -*__description__*: Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance. - -*__example__*: - -```javascript -import { switchMap } from 'rxjs/operators'; -import Api from '@polkadot/api/rx'; - -Api.create() - .pipe( - switchMap((api) => - api.rpc.chain.subscribeNewHead() - )) - .subscribe((header) => { - console.log(`new block #${header.blockNumber.toNumber()}`); - }); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` options | [ApiOptions](../interfaces/_types_.apioptions.md) \| `ProviderInterface` | options that is passed to the class contructor. Can be either [ApiOptions](../interfaces/_types_.apioptions.md) or \[\[WsProvider\]\] | - -**Returns:** `Observable`<[ApiRx](_rx_api_.apirx.md)> - -___ - diff --git a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.html b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.html deleted file mode 100644 index 6d99363a0d..0000000000 --- a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

CodecResult

SubscriptionResult

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

Extrinsic

↳ SubmittableExtrinsic

Implements

  • Codec

Constructors

constructor

⊕ new SubmittableExtrinsic(type: ApiType, api: ApiInterface$Rx, onCall: OnCallDefinition<CodecResult, SubscriptionResult>, extrinsic: Extrinsic | Method): SubmittableExtrinsic

Overrides Extrinsic.__constructor

Defined in SubmittableExtrinsic.ts:62

Parameters:

Name Type
type ApiType
api ApiInterface$Rx
onCall OnCallDefinition<CodecResult, SubscriptionResult>
extrinsic Extrinsic | Method

Returns: SubmittableExtrinsic

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

args

get args(): Array<Codec>

Inherited from Extrinsic.args

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:76

description: The arguments passed to for the call, exposes args so it is compatible with [[Method]]

Returns: Array<Codec>

callIndex

get callIndex(): Uint8Array

Inherited from Extrinsic.callIndex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:83

description: The actual [sectionIndex, methodIndex] as used in the Method

Returns: Uint8Array

data

get data(): Uint8Array

Inherited from Extrinsic.data

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:90

description: The actual data for the Method

Returns: Uint8Array

encodedLength

get encodedLength(): number

Inherited from Extrinsic.encodedLength

Overrides Struct.encodedLength

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:97

description: The length of the value when encoded as a Uint8Array

Returns: number

hash

get hash(): Hash

Inherited from Extrinsic.hash

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:106

description: Convernience function, encodes the extrinsic and returns the actual hash

Returns: Hash

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

isSigned

get isSigned(): boolean

Inherited from Extrinsic.isSigned

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:115

description: true id the extrinsic is signed

Returns: boolean

length

get length(): number

Inherited from Extrinsic.length

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:122

description: The length of the encoded value

Returns: number

meta

get meta(): FunctionMetadata

Inherited from Extrinsic.meta

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:129

description: The [[FunctionMetadata]] that describes the extrinsic

Returns: FunctionMetadata

method

get method(): Method

Inherited from Extrinsic.method

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:136

description: The [[Method]] this extrinsic wraps

Returns: Method

signature

get signature(): ExtrinsicSignature

Inherited from Extrinsic.signature

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:143

description: The [[ExtrinsicSignature]]

Returns: ExtrinsicSignature

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

addSignature

▸ addSignature(signer: Address | Uint8Array, signature: Uint8Array, nonce: AnyNumber, era?: Uint8Array): Extrinsic

Inherited from Extrinsic.addSignature

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:150

description: Add an [[ExtrinsicSignature]] to the extrinsic (already generated)

Parameters:

Name Type
signer Address | Uint8Array
signature Uint8Array
nonce AnyNumber
Optional era Uint8Array

Returns: Extrinsic

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Inherited from Struct.eq

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

send

▸ send(): SumbitableResultResult<CodecResult, SubscriptionResult>

▸ send(statusCb: function): SumbitableResultSubscription<CodecResult, SubscriptionResult>

Defined in SubmittableExtrinsic.ts:135

Returns: SumbitableResultResult<CodecResult, SubscriptionResult>

Defined in SubmittableExtrinsic.ts:136

Parameters:

Name Type
statusCb function

Returns: SumbitableResultSubscription<CodecResult, SubscriptionResult>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

sign

▸ sign(account: KeyringPair, _options: Partial<SignatureOptions>): SubmittableExtrinsic<CodecResult, SubscriptionResult>

Overrides Extrinsic.sign

Defined in SubmittableExtrinsic.ts:153

Parameters:

Name Type
account KeyringPair
_options Partial<SignatureOptions>

Returns: SubmittableExtrinsic<CodecResult, SubscriptionResult>

signAndSend

▸ signAndSend(account: KeyringPair | string | AccountId | Address, options?: Partial<Partial<SignatureOptions>>): SumbitableResultResult<CodecResult, SubscriptionResult>

▸ signAndSend(account: KeyringPair | string | AccountId | Address, statusCb: StatusCb): SumbitableResultSubscription<CodecResult, SubscriptionResult>

Defined in SubmittableExtrinsic.ts:165

Parameters:

Name Type
account KeyringPair | string | AccountId | Address
Optional options Partial<Partial<SignatureOptions>>

Returns: SumbitableResultResult<CodecResult, SubscriptionResult>

Defined in SubmittableExtrinsic.ts:166

Parameters:

Name Type
account KeyringPair | string | AccountId | Address
statusCb StatusCb

Returns: SumbitableResultSubscription<CodecResult, SubscriptionResult>

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Inherited from Extrinsic.toHex

Overrides Struct.toHex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:168

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Inherited from Extrinsic.toJSON

Overrides Struct.toJSON

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:175

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Inherited from Struct.toString

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Extrinsic.toU8a

Overrides Struct.toU8a

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:183

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> decodeExtrinsic

▸ decodeExtrinsic(value: ExtrinsicValue | AnyU8a | Method): ExtrinsicValue | Array<number> | Uint8Array

Inherited from Extrinsic.decodeExtrinsic

Defined in /home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:44

Parameters:

Name Type
value ExtrinsicValue | AnyU8a | Method

Returns: ExtrinsicValue | Array<number> | Uint8Array

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md b/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md deleted file mode 100644 index c2e756c307..0000000000 --- a/docs/api/classes/_submittableextrinsic_.submittableextrinsic.md +++ /dev/null @@ -1,699 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -#### S : `ConstructorDef` -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - - `Extrinsic` - -**↳ SubmittableExtrinsic** - -# Implements - -* `Codec` - -# Constructors - - - -## constructor - -⊕ **new SubmittableExtrinsic**(type: *[ApiType](../modules/_types_.md#apitype)*, api: *[ApiInterface$Rx](../modules/_types_.md#apiinterface_rx)*, onCall: *[OnCallDefinition](../modules/_types_.md#oncalldefinition)<`CodecResult`, `SubscriptionResult`>*, extrinsic: *`Extrinsic` \| `Method`*): [SubmittableExtrinsic](_submittableextrinsic_.submittableextrinsic.md) - -*Overrides Extrinsic.__constructor* - -*Defined in [SubmittableExtrinsic.ts:62](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L62)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | [ApiType](../modules/_types_.md#apitype) | -| api | [ApiInterface$Rx](../modules/_types_.md#apiinterface_rx) | -| onCall | [OnCallDefinition](../modules/_types_.md#oncalldefinition)<`CodecResult`, `SubscriptionResult`> | -| extrinsic | `Extrinsic` \| `Method` | - -**Returns:** [SubmittableExtrinsic](_submittableextrinsic_.submittableextrinsic.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from Struct.Type* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## args - -**get args**(): `Array`<`Codec`> - -*Inherited from Extrinsic.args* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L76)* - -*__description__*: The arguments passed to for the call, exposes args so it is compatible with \[\[Method\]\] - -**Returns:** `Array`<`Codec`> - -___ - - -## callIndex - -**get callIndex**(): `Uint8Array` - -*Inherited from Extrinsic.callIndex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L83)* - -*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method - -**Returns:** `Uint8Array` - -___ - - -## data - -**get data**(): `Uint8Array` - -*Inherited from Extrinsic.data* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L90)* - -*__description__*: The actual data for the Method - -**Returns:** `Uint8Array` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from Extrinsic.encodedLength* - -*Overrides Struct.encodedLength* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L97)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## hash - -**get hash**(): `Hash` - -*Inherited from Extrinsic.hash* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L106)* - -*__description__*: Convernience function, encodes the extrinsic and returns the actual hash - -**Returns:** `Hash` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from Struct.isEmpty* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isSigned - -**get isSigned**(): `boolean` - -*Inherited from Extrinsic.isSigned* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L115)* - -*__description__*: `true` id the extrinsic is signed - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from Extrinsic.length* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L122)* - -*__description__*: The length of the encoded value - -**Returns:** `number` - -___ - - -## meta - -**get meta**(): `FunctionMetadata` - -*Inherited from Extrinsic.meta* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L129)* - -*__description__*: The \[\[FunctionMetadata\]\] that describes the extrinsic - -**Returns:** `FunctionMetadata` - -___ - - -## method - -**get method**(): `Method` - -*Inherited from Extrinsic.method* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L136)* - -*__description__*: The \[\[Method\]\] this extrinsic wraps - -**Returns:** `Method` - -___ - - -## signature - -**get signature**(): `ExtrinsicSignature` - -*Inherited from Extrinsic.signature* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L143)* - -*__description__*: The \[\[ExtrinsicSignature\]\] - -**Returns:** `ExtrinsicSignature` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, `Codec`]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, `Codec`]> - -___ - - -## addSignature - -▸ **addSignature**(signer: *`Address` \| `Uint8Array`*, signature: *`Uint8Array`*, nonce: *`AnyNumber`*, era?: *`Uint8Array`*): `Extrinsic` - -*Inherited from Extrinsic.addSignature* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L150)* - -*__description__*: Add an \[\[ExtrinsicSignature\]\] to the extrinsic (already generated) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signer | `Address` \| `Uint8Array` | -| signature | `Uint8Array` | -| nonce | `AnyNumber` | -| `Optional` era | `Uint8Array` | - -**Returns:** `Extrinsic` - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, `Codec`]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, `Codec`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Inherited from Struct.eq* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): `Codec` \| `undefined` - -*Inherited from Struct.get* - -*Overrides Map.get* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** `Codec` \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): `Codec` - -*Inherited from Struct.getAtIndex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `Codec` - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## send - -▸ **send**(): `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> - -▸ **send**(statusCb: *`function`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> - -*Defined in [SubmittableExtrinsic.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L135)* - -**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> - -*Defined in [SubmittableExtrinsic.ts:136](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L136)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| statusCb | `function` | - -**Returns:** `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *`Codec`*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | `Codec` | - -**Returns:** `this` - -___ - - -## sign - -▸ **sign**(account: *`KeyringPair`*, _options: *`Partial`<`SignatureOptions`>*): [SubmittableExtrinsic](_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`> - -*Overrides Extrinsic.sign* - -*Defined in [SubmittableExtrinsic.ts:153](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L153)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| account | `KeyringPair` | -| _options | `Partial`<`SignatureOptions`> | - -**Returns:** [SubmittableExtrinsic](_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`> - -___ - - -## signAndSend - -▸ **signAndSend**(account: *`KeyringPair` \| `string` \| `AccountId` \| `Address`*, options?: *`Partial`<`Partial`<`SignatureOptions`>>*): `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> - -▸ **signAndSend**(account: *`KeyringPair` \| `string` \| `AccountId` \| `Address`*, statusCb: *`StatusCb`*): `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> - -*Defined in [SubmittableExtrinsic.ts:165](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L165)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| account | `KeyringPair` \| `string` \| `AccountId` \| `Address` | -| `Optional` options | `Partial`<`Partial`<`SignatureOptions`>> | - -**Returns:** `SumbitableResultResult`<`CodecResult`, `SubscriptionResult`> - -*Defined in [SubmittableExtrinsic.ts:166](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L166)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| account | `KeyringPair` \| `string` \| `AccountId` \| `Address` | -| statusCb | `StatusCb` | - -**Returns:** `SumbitableResultSubscription`<`CodecResult`, `SubscriptionResult`> - -___ - - -## toArray - -▸ **toArray**(): `Array`<`Codec`> - -*Inherited from Struct.toArray* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`Codec`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from Extrinsic.toHex* - -*Overrides Struct.toHex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L168)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from Extrinsic.toJSON* - -*Overrides Struct.toJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L175)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from Struct.toString* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Inherited from Extrinsic.toU8a* - -*Overrides Struct.toU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L183)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`Codec`> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<`Codec`> - -___ - - -## `` decodeExtrinsic - -▸ **decodeExtrinsic**(value: *`ExtrinsicValue` \| `AnyU8a` \| `Method`*): `ExtrinsicValue` \| `Array`<`number`> \| `Uint8Array` - -*Inherited from Extrinsic.decodeExtrinsic* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L44)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `ExtrinsicValue` \| `AnyU8a` \| `Method` | - -**Returns:** `ExtrinsicValue` \| `Array`<`number`> \| `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `Constructor`<`Struct`<`S`>> - -*Inherited from Struct.with* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : `ConstructorDef` -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `Constructor`<`Struct`<`S`>> - -___ - diff --git a/docs/api/classes/_submittableextrinsic_.submittableresult.html b/docs/api/classes/_submittableextrinsic_.submittableresult.html deleted file mode 100644 index 2b6d9f04f7..0000000000 --- a/docs/api/classes/_submittableextrinsic_.submittableresult.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

Struct

↳ SubmittableResult

Implements

  • Codec

Constructors

constructor

⊕ new SubmittableResult(value?: any): SubmittableResult

Overrides Struct.__constructor

Defined in SubmittableExtrinsic.ts:28

Parameters:

Name Type
Optional value any

Returns: SubmittableResult

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

events

get events(): Array<EventRecord>

Defined in SubmittableExtrinsic.ts:40

description: the contained events

Returns: Array<EventRecord>

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

status

get status(): ExtrinsicStatus

Defined in SubmittableExtrinsic.ts:47

description: the status

Returns: ExtrinsicStatus

type

get type(): string

Defined in SubmittableExtrinsic.ts:54

description: the type

Returns: string

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Inherited from Struct.eq

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Inherited from Struct.toHex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Inherited from Struct.toJSON

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Inherited from Struct.toString

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/api/classes/_submittableextrinsic_.submittableresult.md b/docs/api/classes/_submittableextrinsic_.submittableresult.md deleted file mode 100644 index e3c73aa5ec..0000000000 --- a/docs/api/classes/_submittableextrinsic_.submittableresult.md +++ /dev/null @@ -1,473 +0,0 @@ - - -# Type parameters -#### S : `ConstructorDef` -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - - `Struct` - -**↳ SubmittableResult** - -# Implements - -* `Codec` - -# Constructors - - - -## constructor - -⊕ **new SubmittableResult**(value?: *`any`*): [SubmittableResult](_submittableextrinsic_.submittableresult.md) - -*Overrides Struct.__constructor* - -*Defined in [SubmittableExtrinsic.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L28)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [SubmittableResult](_submittableextrinsic_.submittableresult.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from Struct.Type* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from Struct.encodedLength* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## events - -**get events**(): `Array`<`EventRecord`> - -*Defined in [SubmittableExtrinsic.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L40)* - -*__description__*: the contained events - -**Returns:** `Array`<`EventRecord`> - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from Struct.isEmpty* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## status - -**get status**(): `ExtrinsicStatus` - -*Defined in [SubmittableExtrinsic.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L47)* - -*__description__*: the status - -**Returns:** `ExtrinsicStatus` - -___ - - -## type - -**get type**(): `string` - -*Defined in [SubmittableExtrinsic.ts:54](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L54)* - -*__description__*: the type - -**Returns:** `string` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, `Codec`]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, `Codec`]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, `Codec`]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, `Codec`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Inherited from Struct.eq* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): `Codec` \| `undefined` - -*Inherited from Struct.get* - -*Overrides Map.get* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** `Codec` \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): `Codec` - -*Inherited from Struct.getAtIndex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** `Codec` - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *`Codec`*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | `Codec` | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<`Codec`> - -*Inherited from Struct.toArray* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`Codec`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Inherited from Struct.toHex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Inherited from Struct.toJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Inherited from Struct.toString* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Inherited from Struct.toU8a* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`Codec`> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<`Codec`> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `Constructor`<`Struct`<`S`>> - -*Inherited from Struct.with* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : `ConstructorDef` -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `Constructor`<`Struct`<`S`>> - -___ - diff --git a/docs/api/index.html b/docs/api/index.html deleted file mode 100644 index 601fd3f81a..0000000000 --- a/docs/api/index.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/api

The Polkadot-JS API provides easy-to-use wrappers around JSONRPC calls that flow from an application to a node. It handles all the encoding and decoding or parameters, provides access to RPC functions and allows for the query of chain state and the submission of transactions.

The API wrappers provide a standard interface for use -

  • A static .create(<optional ApiOptions>) that returns an API instance when connected, decorated and ready-to use. ApiOptions can include an optional WsProvider and optional custom type definitions { provider: <Optional WsProvider>, types: <Optional RegistryTypes> }.
  • The above is just a wrapper for new Api(<optional ApiOptions>), exposing the isReady getter
  • api.rpc.<section>.<method> provides access to actual RPC calls, be it for queries, submission or retrieving chain information -
  • api.query.<section>.<method> provides access to chain state queries. These are dynamically populated based on what the runtime provides -
  • api.tx.<section>.<method> provides the ability to create a transaction, like chain state, this list is populated from a runtime query -

API Selection

There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using RxJS. Depending on your use-case and familiarity, you can choose either (or even both) for your application.

  • ApiPromise All interface calls returns Promises, including the static .create(...). Additionally any subscription method uses (value) => {} callbacks, returning the value as the subscription is updated.
  • ApiRx All interface calls return RxJS Observables, including the static .create(...). In the same fashion subscription-based methods return long-running Observables that update with the latest values.

Dynamic by default

Substrate (upon which Polkadot is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.

Due to this dynamic nature, this API departs from traditional APIs which only has fixed endpoints, driving use by what is available by the runtime. As a start, this generic nature has a learning curve, although the provided documentation, examples and linked documentation tries to make that experience as seamless as possible.

Installation & import

Installation -

npm install --save @polkadot/api
-
1

Subscribing to blocks via Promise-based API -

import { ApiPromise } from '@polkadot/api';
-
-// initialise via static create
-const api = await ApiPromise.create();
-
-// make a call to retrieve the current network head
-api.rpc.chain.subscribeNewHead((header) => {
-  console.log(`Chain is at #${header.blockNumber}`);
-});
-
1
2
3
4
5
6
7
8
9

Subscribing to blocks via RxJS-based API -

import { ApiRx } from '@polkadot/api';
-
-// initialise via static create
-const api = await ApiRx.create().toPromise();
-
-// make a call to retrieve the current network head
-api.rpc.chain.subscribeNewHead().subscribe((header) => {
-  console.log(`Chain is at #${header.blockNumber}`);
-});
-
1
2
3
4
5
6
7
8
9

Registering custom types

Additional types used by runtime modules can be added when a new instance of the API is created. This is necessary if the runtime modules use types which are not available in the base Substrate runtime.

import { ApiPromise } from '@polkadot/api';
-
-// initialise via static create and register custom types
-const api = await ApiPromise.create({
-  types: {
-    CustomTypesExample: {
-      "id": "u32",
-      "data": "Vec<u8>",
-      "deposit": "Balance",
-      "owner": "AccountId",
-      "application_expiry": "Moment",
-      "whitelisted": "bool",
-      "challenge_id": "u32"
-    }
-  }
-});
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Users

Some of the users of the API (let us know if you are missing from the list), include -

Classes

Classes

- ← - - @polkadot/types - - → -

- - - diff --git a/docs/api/interfaces/_promise_types_.apipromiseinterface.html b/docs/api/interfaces/_promise_types_.apipromiseinterface.html deleted file mode 100644 index 0a63c7f058..0000000000 --- a/docs/api/interfaces/_promise_types_.apipromiseinterface.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

ApiBase<CodecResult, SubscriptionResult>

↳ ApiPromiseInterface

Implements

Implemented by

Constructors

constructor

⊕ new ApiPromiseInterface(provider?: ApiOptions | ProviderInterface, type: ApiType): ApiPromiseInterface

Inherited from ApiBase.constructor

Defined in Base.ts:81

description: Create an instance of the class

example:

import Api from '@polkadot/api/promise';
-
-const api = new Api().isReady();
-
-api.rpc.subscribeNewHead((header) => {
-  console.log(`new block #${header.blockNumber.toNumber()}`);
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value
Default value provider ApiOptions | ProviderInterface {}
type ApiType -

Returns: ApiPromiseInterface

Properties

isReady

● isReady: Promise<ApiPromiseInterface>

Defined in promise/types.ts:16

Accessors

derive

get derive(): Derive<CodecResult, SubscriptionResult>

Inherited from ApiBase.derive

Defined in Base.ts:196

description: Derived results that are injected into the API, allowing for combinations of various query results.

example:

api.derive.chain.bestNumber((number) => {
-  console.log('best number', number);
-});
-
1
2
3

Returns: Derive<CodecResult, SubscriptionResult>

genesisHash

get genesisHash(): Hash

Inherited from ApiBase.genesisHash

Defined in Base.ts:132

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash

hasSubscriptions

get hasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

Defined in Base.ts:141

description: true when subscriptions are supported

Returns: boolean

libraryInfo

get libraryInfo(): string

Inherited from ApiBase.libraryInfo

Defined in Base.ts:148

description: The library information name & version (from package.json)

Returns: string

query

get query(): QueryableStorage<CodecResult, SubscriptionResult>

Inherited from ApiBase.query

Defined in Base.ts:216

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

api.query.balances.freeBalance(<accountId>, (balance) => {
-  console.log('new balance', balance);
-});
-
1
2
3

Returns: QueryableStorage<CodecResult, SubscriptionResult>

rpc

get rpc(): DecoratedRpc<CodecResult, SubscriptionResult>

Inherited from ApiBase.rpc

Defined in Base.ts:236

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

api.rpc.chain.subscribeNewHead((header) => {
-  console.log('new header', header);
-});
-
1
2
3

Returns: DecoratedRpc<CodecResult, SubscriptionResult>

runtimeMetadata

get runtimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

Defined in Base.ts:155

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: Metadata

runtimeVersion

get runtimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

Defined in Base.ts:164

description: Contains the version information for the current runtime.

Returns: RuntimeVersion

tx

get tx(): SubmittableExtrinsics<CodecResult, SubscriptionResult>

Inherited from ApiBase.tx

Defined in Base.ts:254

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
-  .transfer(<recipientId>, <balance>)
-  .signAndSend(<keyPair>, ({status}) => {
-    console.log('tx status', status.asFinalised.toHex());
-  });
-
1
2
3
4
5

Returns: SubmittableExtrinsics<CodecResult, SubscriptionResult>

type

get type(): ApiType

Inherited from ApiBase.type

Defined in Base.ts:173

description: The type of this API instance, either 'rxjs' or 'promise'

Returns: ApiType

Methods

disconnect

▸ disconnect(): void

Inherited from ApiBase.disconnect

Defined in Base.ts:263

description: Disconnect from the underlying provider, halting all comms

Returns: void

on

▸ on(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.on

Defined in Base.ts:286

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.on('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

once

▸ once(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.once

Defined in Base.ts:311

description: Attach an one-time eventemitter handler to listen to a specific event

example:

api.once('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.once('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

registerTypes

▸ registerTypes(types?: RegistryTypes): void

Inherited from ApiBase.registerTypes

Defined in Base.ts:320

description: Register additional user-defined of chain-specific types in the type registry

Parameters:

Name Type
Optional types RegistryTypes

Returns: void

setSigner

▸ setSigner(signer: Signer): void

Inherited from ApiBase.setSigner

Defined in Base.ts:180

description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair

Parameters:

Name Type
signer Signer

Returns: void

- - - diff --git a/docs/api/interfaces/_promise_types_.apipromiseinterface.md b/docs/api/interfaces/_promise_types_.apipromiseinterface.md deleted file mode 100644 index ee505fb060..0000000000 --- a/docs/api/interfaces/_promise_types_.apipromiseinterface.md +++ /dev/null @@ -1,384 +0,0 @@ - - -# Hierarchy - - [ApiBase](../classes/_base_.apibase.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -**↳ ApiPromiseInterface** - -# Implements - -* [ApiBaseInterface](_types_.apibaseinterface.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -# Implemented by - -* [ApiPromise](../classes/_promise_api_.apipromise.md) - -# Constructors - - - -## constructor - -⊕ **new ApiPromiseInterface**(provider?: *[ApiOptions](_types_.apioptions.md) \| `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiPromiseInterface](_promise_types_.apipromiseinterface.md) - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* - -*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L81)* - -*__description__*: Create an instance of the class - -*__example__*: - -```javascript -import Api from '@polkadot/api/promise'; - -const api = new Api().isReady(); - -api.rpc.subscribeNewHead((header) => { - console.log(`new block #${header.blockNumber.toNumber()}`); -}); -``` - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` provider | [ApiOptions](_types_.apioptions.md) \| `ProviderInterface` | {} | -| type | [ApiType](../modules/_types_.md#apitype) | - | - -**Returns:** [ApiPromiseInterface](_promise_types_.apipromiseinterface.md) - -___ - -# Properties - - - -## isReady - -**● isReady**: *`Promise`<[ApiPromiseInterface](_promise_types_.apipromiseinterface.md)>* - -*Defined in [promise/types.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L16)* - -___ - -# Accessors - - - -## derive - -**get derive**(): [Derive](_types_.derive.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* - -*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196)* - -*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. - -*__example__*: - -```javascript -api.derive.chain.bestNumber((number) => { - console.log('best number', number); -}); -``` - -**Returns:** [Derive](_types_.derive.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -___ - - -## genesisHash - -**get genesisHash**(): `Hash` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132)* - -*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. - -**Returns:** `Hash` - -___ - - -## hasSubscriptions - -**get hasSubscriptions**(): `boolean` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* - -*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141)* - -*__description__*: `true` when subscriptions are supported - -**Returns:** `boolean` - -___ - - -## libraryInfo - -**get libraryInfo**(): `string` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[libraryInfo](../classes/_base_.apibase.md#libraryinfo)* - -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148)* - -*__description__*: The library information name & version (from package.json) - -**Returns:** `string` - -___ - - -## query - -**get query**(): [QueryableStorage](_types_.queryablestorage.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* - -*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216)* - -*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. - -All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.query.timestamp.now()` (current block timestamp) does not take parameters, while `api.query.system.accountNonce()` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter. - -*__example__*: - -```javascript -api.query.balances.freeBalance(, (balance) => { - console.log('new balance', balance); -}); -``` - -**Returns:** [QueryableStorage](_types_.queryablestorage.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -___ - - -## rpc - -**get rpc**(): [DecoratedRpc](_types_.decoratedrpc.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* - -*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236)* - -*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. - -RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions. - -*__example__*: - -```javascript -api.rpc.chain.subscribeNewHead((header) => { - console.log('new header', header); -}); -``` - -**Returns:** [DecoratedRpc](_types_.decoratedrpc.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -___ - - -## runtimeMetadata - -**get runtimeMetadata**(): `Metadata` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* - -*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155)* - -*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. - -**Returns:** `Metadata` - -___ - - -## runtimeVersion - -**get runtimeVersion**(): `RuntimeVersion` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* - -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164)* - -*__description__*: Contains the version information for the current runtime. - -**Returns:** `RuntimeVersion` - -___ - - -## tx - -**get tx**(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* - -*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254)* - -*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. - -*__example__*: - -```javascript -api.tx.balances - .transfer(, ) - .signAndSend(, ({status}) => { - console.log('tx status', status.asFinalised.toHex()); - }); -``` - -**Returns:** [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[CodecResult](../modules/_promise_types_.md#codecresult), [SubscriptionResult](../modules/_promise_types_.md#subscriptionresult)> - -___ - - -## type - -**get type**(): [ApiType](../modules/_types_.md#apitype) - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* - -*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173)* - -*__description__*: The type of this API instance, either 'rxjs' or 'promise' - -**Returns:** [ApiType](../modules/_types_.md#apitype) - -___ - -# Methods - - - -## disconnect - -▸ **disconnect**(): `void` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* - -*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263)* - -*__description__*: Disconnect from the underlying provider, halting all comms - -**Returns:** `void` - -___ - - -## on - -▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* - -*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286)* - -*__description__*: Attach an eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.on('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.on('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## once - -▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* - -*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311)* - -*__description__*: Attach an one-time eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.once('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.once('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## registerTypes - -▸ **registerTypes**(types?: *`RegistryTypes`*): `void` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)* - -*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320)* - -*__description__*: Register additional user-defined of chain-specific types in the type registry - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` types | `RegistryTypes` | - -**Returns:** `void` - -___ - - -## setSigner - -▸ **setSigner**(signer: *[Signer](_types_.signer.md)*): `void` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)* - -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180)* - -*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signer | [Signer](_types_.signer.md) | - -**Returns:** `void` - -___ - diff --git a/docs/api/interfaces/_rx_types_.apirxinterface.html b/docs/api/interfaces/_rx_types_.apirxinterface.html deleted file mode 100644 index 8e0f7651e3..0000000000 --- a/docs/api/interfaces/_rx_types_.apirxinterface.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

ApiBase<RxResult, RxResult>

↳ ApiRxInterface

Implements

Implemented by

Constructors

constructor

⊕ new ApiRxInterface(provider?: ApiOptions | ProviderInterface, type: ApiType): ApiRxInterface

Inherited from ApiBase.constructor

Defined in Base.ts:81

description: Create an instance of the class

example:

import Api from '@polkadot/api/promise';
-
-const api = new Api().isReady();
-
-api.rpc.subscribeNewHead((header) => {
-  console.log(`new block #${header.blockNumber.toNumber()}`);
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Default value
Default value provider ApiOptions | ProviderInterface {}
type ApiType -

Returns: ApiRxInterface

Properties

isConnected

● isConnected: Observable<boolean>

Defined in rx/types.ts:13

isReady

● isReady: Observable<ApiRxInterface>

Defined in rx/types.ts:14

Accessors

derive

get derive(): Derive<RxResult, RxResult>

Inherited from ApiBase.derive

Defined in Base.ts:196

description: Derived results that are injected into the API, allowing for combinations of various query results.

example:

api.derive.chain.bestNumber((number) => {
-  console.log('best number', number);
-});
-
1
2
3

Returns: Derive<RxResult, RxResult>

genesisHash

get genesisHash(): Hash

Inherited from ApiBase.genesisHash

Defined in Base.ts:132

description: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.

Returns: Hash

hasSubscriptions

get hasSubscriptions(): boolean

Inherited from ApiBase.hasSubscriptions

Defined in Base.ts:141

description: true when subscriptions are supported

Returns: boolean

libraryInfo

get libraryInfo(): string

Inherited from ApiBase.libraryInfo

Defined in Base.ts:148

description: The library information name & version (from package.json)

Returns: string

query

get query(): QueryableStorage<RxResult, RxResult>

Inherited from ApiBase.query

Defined in Base.ts:216

description: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.

All calls inside the namespace, is denoted by section.method and may take an optional query parameter. As an example, api.query.timestamp.now() (current block timestamp) does not take parameters, while api.query.system.accountNonce(<accountId>) (retrieving the associated nonce for an account), takes the AccountId as a parameter.

example:

api.query.balances.freeBalance(<accountId>, (balance) => {
-  console.log('new balance', balance);
-});
-
1
2
3

Returns: QueryableStorage<RxResult, RxResult>

rpc

get rpc(): DecoratedRpc<RxResult, RxResult>

Inherited from ApiBase.rpc

Defined in Base.ts:236

description: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic api.query and api.tx sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.

RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.

example:

api.rpc.chain.subscribeNewHead((header) => {
-  console.log('new header', header);
-});
-
1
2
3

Returns: DecoratedRpc<RxResult, RxResult>

runtimeMetadata

get runtimeMetadata(): Metadata

Inherited from ApiBase.runtimeMetadata

Defined in Base.ts:155

description: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.

Returns: Metadata

runtimeVersion

get runtimeVersion(): RuntimeVersion

Inherited from ApiBase.runtimeVersion

Defined in Base.ts:164

description: Contains the version information for the current runtime.

Returns: RuntimeVersion

tx

get tx(): SubmittableExtrinsics<RxResult, RxResult>

Inherited from ApiBase.tx

Defined in Base.ts:254

description: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.

example:

api.tx.balances
-  .transfer(<recipientId>, <balance>)
-  .signAndSend(<keyPair>, ({status}) => {
-    console.log('tx status', status.asFinalised.toHex());
-  });
-
1
2
3
4
5

Returns: SubmittableExtrinsics<RxResult, RxResult>

type

get type(): ApiType

Inherited from ApiBase.type

Defined in Base.ts:173

description: The type of this API instance, either 'rxjs' or 'promise'

Returns: ApiType

Methods

disconnect

▸ disconnect(): void

Inherited from ApiBase.disconnect

Defined in Base.ts:263

description: Disconnect from the underlying provider, halting all comms

Returns: void

on

▸ on(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.on

Defined in Base.ts:286

description: Attach an eventemitter handler to listen to a specific event

example:

api.on('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.on('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

once

▸ once(type: ApiInterface$Events, handler: function): this

Inherited from ApiBase.once

Defined in Base.ts:311

description: Attach an one-time eventemitter handler to listen to a specific event

example:

api.once('connected', () => {
-  console.log('API has been connected to the endpoint');
-});
-
-api.once('disconnected', () => {
-  console.log('API has been disconnected from the endpoint');
-});
-
1
2
3
4
5
6
7

Parameters:

Name Type Description
type ApiInterface$Events The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`
handler function The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.

Returns: this

registerTypes

▸ registerTypes(types?: RegistryTypes): void

Inherited from ApiBase.registerTypes

Defined in Base.ts:320

description: Register additional user-defined of chain-specific types in the type registry

Parameters:

Name Type
Optional types RegistryTypes

Returns: void

setSigner

▸ setSigner(signer: Signer): void

Inherited from ApiBase.setSigner

Defined in Base.ts:180

description: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair

Parameters:

Name Type
signer Signer

Returns: void

- - - diff --git a/docs/api/interfaces/_rx_types_.apirxinterface.md b/docs/api/interfaces/_rx_types_.apirxinterface.md deleted file mode 100644 index 35b1137895..0000000000 --- a/docs/api/interfaces/_rx_types_.apirxinterface.md +++ /dev/null @@ -1,393 +0,0 @@ - - -# Hierarchy - - [ApiBase](../classes/_base_.apibase.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -**↳ ApiRxInterface** - -# Implements - -* [ApiBaseInterface](_types_.apibaseinterface.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -# Implemented by - -* [ApiRx](../classes/_rx_api_.apirx.md) - -# Constructors - - - -## constructor - -⊕ **new ApiRxInterface**(provider?: *[ApiOptions](_types_.apioptions.md) \| `ProviderInterface`*, type: *[ApiType](../modules/_types_.md#apitype)*): [ApiRxInterface](_rx_types_.apirxinterface.md) - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[constructor](../classes/_base_.apibase.md#constructor)* - -*Defined in [Base.ts:81](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L81)* - -*__description__*: Create an instance of the class - -*__example__*: - -```javascript -import Api from '@polkadot/api/promise'; - -const api = new Api().isReady(); - -api.rpc.subscribeNewHead((header) => { - console.log(`new block #${header.blockNumber.toNumber()}`); -}); -``` - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` provider | [ApiOptions](_types_.apioptions.md) \| `ProviderInterface` | {} | -| type | [ApiType](../modules/_types_.md#apitype) | - | - -**Returns:** [ApiRxInterface](_rx_types_.apirxinterface.md) - -___ - -# Properties - - - -## isConnected - -**● isConnected**: *`Observable`<`boolean`>* - -*Defined in [rx/types.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/types.ts#L13)* - -___ - - -## isReady - -**● isReady**: *`Observable`<[ApiRxInterface](_rx_types_.apirxinterface.md)>* - -*Defined in [rx/types.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/types.ts#L14)* - -___ - -# Accessors - - - -## derive - -**get derive**(): [Derive](_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[derive](../classes/_base_.apibase.md#derive)* - -*Defined in [Base.ts:196](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196)* - -*__description__*: Derived results that are injected into the API, allowing for combinations of various query results. - -*__example__*: - -```javascript -api.derive.chain.bestNumber((number) => { - console.log('best number', number); -}); -``` - -**Returns:** [Derive](_types_.derive.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## genesisHash - -**get genesisHash**(): `Hash` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[genesisHash](../classes/_base_.apibase.md#genesishash)* - -*Defined in [Base.ts:132](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132)* - -*__description__*: Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions. - -**Returns:** `Hash` - -___ - - -## hasSubscriptions - -**get hasSubscriptions**(): `boolean` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[hasSubscriptions](../classes/_base_.apibase.md#hassubscriptions)* - -*Defined in [Base.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141)* - -*__description__*: `true` when subscriptions are supported - -**Returns:** `boolean` - -___ - - -## libraryInfo - -**get libraryInfo**(): `string` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[libraryInfo](../classes/_base_.apibase.md#libraryinfo)* - -*Defined in [Base.ts:148](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148)* - -*__description__*: The library information name & version (from package.json) - -**Returns:** `string` - -___ - - -## query - -**get query**(): [QueryableStorage](_types_.queryablestorage.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[query](../classes/_base_.apibase.md#query)* - -*Defined in [Base.ts:216](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216)* - -*__description__*: Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata. - -All calls inside the namespace, is denoted by `section`.`method` and may take an optional query parameter. As an example, `api.query.timestamp.now()` (current block timestamp) does not take parameters, while `api.query.system.accountNonce()` (retrieving the associated nonce for an account), takes the `AccountId` as a parameter. - -*__example__*: - -```javascript -api.query.balances.freeBalance(, (balance) => { - console.log('new balance', balance); -}); -``` - -**Returns:** [QueryableStorage](_types_.queryablestorage.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## rpc - -**get rpc**(): [DecoratedRpc](_types_.decoratedrpc.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[rpc](../classes/_base_.apibase.md#rpc)* - -*Defined in [Base.ts:236](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236)* - -*__description__*: Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic `api.query` and `api.tx` sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime. - -RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions. - -*__example__*: - -```javascript -api.rpc.chain.subscribeNewHead((header) => { - console.log('new header', header); -}); -``` - -**Returns:** [DecoratedRpc](_types_.decoratedrpc.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## runtimeMetadata - -**get runtimeMetadata**(): `Metadata` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeMetadata](../classes/_base_.apibase.md#runtimemetadata)* - -*Defined in [Base.ts:155](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155)* - -*__description__*: Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection. - -**Returns:** `Metadata` - -___ - - -## runtimeVersion - -**get runtimeVersion**(): `RuntimeVersion` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[runtimeVersion](../classes/_base_.apibase.md#runtimeversion)* - -*Defined in [Base.ts:164](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164)* - -*__description__*: Contains the version information for the current runtime. - -**Returns:** `RuntimeVersion` - -___ - - -## tx - -**get tx**(): [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[tx](../classes/_base_.apibase.md#tx)* - -*Defined in [Base.ts:254](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254)* - -*__description__*: Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata. - -*__example__*: - -```javascript -api.tx.balances - .transfer(, ) - .signAndSend(, ({status}) => { - console.log('tx status', status.asFinalised.toHex()); - }); -``` - -**Returns:** [SubmittableExtrinsics](_types_.submittableextrinsics.md)<[RxResult](../modules/_rx_types_.md#rxresult), [RxResult](../modules/_rx_types_.md#rxresult)> - -___ - - -## type - -**get type**(): [ApiType](../modules/_types_.md#apitype) - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[type](../classes/_base_.apibase.md#type)* - -*Defined in [Base.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173)* - -*__description__*: The type of this API instance, either 'rxjs' or 'promise' - -**Returns:** [ApiType](../modules/_types_.md#apitype) - -___ - -# Methods - - - -## disconnect - -▸ **disconnect**(): `void` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[disconnect](../classes/_base_.apibase.md#disconnect)* - -*Defined in [Base.ts:263](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263)* - -*__description__*: Disconnect from the underlying provider, halting all comms - -**Returns:** `void` - -___ - - -## on - -▸ **on**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[on](../classes/_base_.apibase.md#on)* - -*Defined in [Base.ts:286](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286)* - -*__description__*: Attach an eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.on('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.on('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## once - -▸ **once**(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[once](../classes/_base_.apibase.md#once)* - -*Defined in [Base.ts:311](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311)* - -*__description__*: Attach an one-time eventemitter handler to listen to a specific event - -*__example__*: - -```javascript -api.once('connected', () => { - console.log('API has been connected to the endpoint'); -}); - -api.once('disconnected', () => { - console.log('API has been disconnected from the endpoint'); -}); -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | The type of event to listen to. Available events are \`connected\`, \`disconnected\`, \`ready\` and \`error\` | -| handler | `function` | The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments. | - -**Returns:** `this` - -___ - - -## registerTypes - -▸ **registerTypes**(types?: *`RegistryTypes`*): `void` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[registerTypes](../classes/_base_.apibase.md#registertypes)* - -*Defined in [Base.ts:320](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320)* - -*__description__*: Register additional user-defined of chain-specific types in the type registry - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` types | `RegistryTypes` | - -**Returns:** `void` - -___ - - -## setSigner - -▸ **setSigner**(signer: *[Signer](_types_.signer.md)*): `void` - -*Inherited from [ApiBase](../classes/_base_.apibase.md).[setSigner](../classes/_base_.apibase.md#setsigner)* - -*Defined in [Base.ts:180](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180)* - -*__description__*: Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signer | [Signer](_types_.signer.md) | - -**Returns:** `void` - -___ - diff --git a/docs/api/interfaces/_types_.apibaseinterface.html b/docs/api/interfaces/_types_.apibaseinterface.html deleted file mode 100644 index 1d32c49c19..0000000000 --- a/docs/api/interfaces/_types_.apibaseinterface.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.apibaseinterface.md b/docs/api/interfaces/_types_.apibaseinterface.md deleted file mode 100644 index 49e86faa58..0000000000 --- a/docs/api/interfaces/_types_.apibaseinterface.md +++ /dev/null @@ -1,73 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - - `object` - -**↳ ApiBaseInterface** - -# Implemented by - -* [ApiBase](../classes/_base_.apibase.md) -* [ApiPromise](../classes/_promise_api_.apipromise.md) -* [ApiPromiseInterface](_promise_types_.apipromiseinterface.md) -* [ApiRx](../classes/_rx_api_.apirx.md) -* [ApiRxInterface](_rx_types_.apirxinterface.md) - -# Properties - - - -## on - -**● on**: *`function`* - -*Defined in [types.ts:158](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L158)* - -#### Type declaration -▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | -| handler | `function` | - -**Returns:** `this` - -___ - - -## once - -**● once**: *`function`* - -*Defined in [types.ts:159](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L159)* - -#### Type declaration -▸(type: *[ApiInterface$Events](../modules/_types_.md#apiinterface_events)*, handler: *`function`*): `this` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | [ApiInterface$Events](../modules/_types_.md#apiinterface_events) | -| handler | `function` | - -**Returns:** `this` - -___ - - -## type - -**● type**: *[ApiType](../modules/_types_.md#apitype)* - -*Defined in [types.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L156)* - -___ - diff --git a/docs/api/interfaces/_types_.apiinterface_decorated.html b/docs/api/interfaces/_types_.apiinterface_decorated.html deleted file mode 100644 index f286521186..0000000000 --- a/docs/api/interfaces/_types_.apiinterface_decorated.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

CodecResult

SubscriptionResult

Hierarchy

ApiInterface$Decorated

Properties

derive

● derive: Derive<CodecResult, SubscriptionResult>

Defined in types.ts:142

genesisHash

● genesisHash: Hash

Defined in types.ts:138

hasSubscriptions

● hasSubscriptions: boolean

Defined in types.ts:139

query

● query: QueryableStorage<CodecResult, SubscriptionResult>

Defined in types.ts:143

rpc

● rpc: DecoratedRpc<CodecResult, SubscriptionResult>

Defined in types.ts:144

runtimeMetadata

● runtimeMetadata: Metadata

Defined in types.ts:140

runtimeVersion

● runtimeVersion: RuntimeVersion

Defined in types.ts:141

<Optional> signer

● signer: Signer

Defined in types.ts:146

tx

● tx: SubmittableExtrinsics<CodecResult, SubscriptionResult>

Defined in types.ts:145

- - - diff --git a/docs/api/interfaces/_types_.apiinterface_decorated.md b/docs/api/interfaces/_types_.apiinterface_decorated.md deleted file mode 100644 index 98900e9d9e..0000000000 --- a/docs/api/interfaces/_types_.apiinterface_decorated.md +++ /dev/null @@ -1,93 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**ApiInterface$Decorated** - -# Properties - - - -## derive - -**● derive**: *[Derive](_types_.derive.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L142)* - -___ - - -## genesisHash - -**● genesisHash**: *`Hash`* - -*Defined in [types.ts:138](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L138)* - -___ - - -## hasSubscriptions - -**● hasSubscriptions**: *`boolean`* - -*Defined in [types.ts:139](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L139)* - -___ - - -## query - -**● query**: *[QueryableStorage](_types_.queryablestorage.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:143](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L143)* - -___ - - -## rpc - -**● rpc**: *[DecoratedRpc](_types_.decoratedrpc.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:144](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L144)* - -___ - - -## runtimeMetadata - -**● runtimeMetadata**: *`Metadata`* - -*Defined in [types.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L140)* - -___ - - -## runtimeVersion - -**● runtimeVersion**: *`RuntimeVersion`* - -*Defined in [types.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L141)* - -___ - - -## `` signer - -**● signer**: *[Signer](_types_.signer.md)* - -*Defined in [types.ts:146](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L146)* - -___ - - -## tx - -**● tx**: *[SubmittableExtrinsics](_types_.submittableextrinsics.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L145)* - -___ - diff --git a/docs/api/interfaces/_types_.apioptions.html b/docs/api/interfaces/_types_.apioptions.html deleted file mode 100644 index 074bfb44a4..0000000000 --- a/docs/api/interfaces/_types_.apioptions.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

ApiOptions

Properties

<Optional> derives

● derives: DeriveCustom

Defined in types.ts:116

description: Add custom derives to be injected

<Optional> provider

● provider: ProviderInterface

Defined in types.ts:121

description: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. ws://127.0.0.1:9944

<Optional> signer

● signer: Signer

Defined in types.ts:125

description: An external signer which will be used to sign extrinsic when account passed in is not KeyringPair

<Optional> source

● source: ApiBase<any, any>

Defined in types.ts:129

description: The source object to use for runtime information (only used when cloning)

<Optional> types

● types: RegistryTypes

Defined in types.ts:134

description: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.

- - - diff --git a/docs/api/interfaces/_types_.apioptions.md b/docs/api/interfaces/_types_.apioptions.md deleted file mode 100644 index 9494c30956..0000000000 --- a/docs/api/interfaces/_types_.apioptions.md +++ /dev/null @@ -1,64 +0,0 @@ - - -# Hierarchy - -**ApiOptions** - -# Properties - - - -## `` derives - -**● derives**: *`DeriveCustom`* - -*Defined in [types.ts:116](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L116)* - -*__description__*: Add custom derives to be injected - -___ - - -## `` provider - -**● provider**: *`ProviderInterface`* - -*Defined in [types.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L121)* - -*__description__*: Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. `ws://127.0.0.1:9944` - -___ - - -## `` signer - -**● signer**: *[Signer](_types_.signer.md)* - -*Defined in [types.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L125)* - -*__description__*: An external signer which will be used to sign extrinsic when account passed in is not KeyringPair - -___ - - -## `` source - -**● source**: *[ApiBase](../classes/_base_.apibase.md)<`any`, `any`>* - -*Defined in [types.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L129)* - -*__description__*: The source object to use for runtime information (only used when cloning) - -___ - - -## `` types - -**● types**: *`RegistryTypes`* - -*Defined in [types.ts:134](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L134)* - -*__description__*: Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime. - -___ - diff --git a/docs/api/interfaces/_types_.decoratedrpc.html b/docs/api/interfaces/_types_.decoratedrpc.html deleted file mode 100644 index 52df70125a..0000000000 --- a/docs/api/interfaces/_types_.decoratedrpc.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.decoratedrpc.md b/docs/api/interfaces/_types_.decoratedrpc.md deleted file mode 100644 index 8309a39d80..0000000000 --- a/docs/api/interfaces/_types_.decoratedrpc.md +++ /dev/null @@ -1,48 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**DecoratedRpc** - -# Properties - - - -## author - -**● author**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L34)* - -___ - - -## chain - -**● chain**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L35)* - -___ - - -## state - -**● state**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L36)* - -___ - - -## system - -**● system**: *[DecoratedRpc$Section](_types_.decoratedrpc_section.md)<`CodecResult`, `SubscriptionResult`>* - -*Defined in [types.ts:37](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L37)* - -___ - diff --git a/docs/api/interfaces/_types_.decoratedrpc_method.html b/docs/api/interfaces/_types_.decoratedrpc_method.html deleted file mode 100644 index 6bd79d4851..0000000000 --- a/docs/api/interfaces/_types_.decoratedrpc_method.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

CodecResult

SubscriptionResult

Hierarchy

DecoratedRpc$Method

Callable

▸ __call(callback: CodecCallback): SubscriptionResult

▸ __call(arg1: CodecArg, callback: CodecCallback): SubscriptionResult

▸ __call(arg1?: CodecArg, arg2?: CodecArg, arg3?: CodecArg): CodecResult

Defined in types.ts:23

Parameters:

Name Type
callback CodecCallback

Returns: SubscriptionResult

Defined in types.ts:24

Parameters:

Name Type
arg1 CodecArg
callback CodecCallback

Returns: SubscriptionResult

Defined in types.ts:25

Parameters:

Name Type
Optional arg1 CodecArg
Optional arg2 CodecArg
Optional arg3 CodecArg

Returns: CodecResult

- - - diff --git a/docs/api/interfaces/_types_.decoratedrpc_method.md b/docs/api/interfaces/_types_.decoratedrpc_method.md deleted file mode 100644 index a427f89b24..0000000000 --- a/docs/api/interfaces/_types_.decoratedrpc_method.md +++ /dev/null @@ -1,49 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**DecoratedRpc$Method** - -# Callable -▸ **__call**(callback: *`CodecCallback`*): `SubscriptionResult` - -▸ **__call**(arg1: *`CodecArg`*, callback: *`CodecCallback`*): `SubscriptionResult` - -▸ **__call**(arg1?: *`CodecArg`*, arg2?: *`CodecArg`*, arg3?: *`CodecArg`*): `CodecResult` - -*Defined in [types.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L23)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callback | `CodecCallback` | - -**Returns:** `SubscriptionResult` - -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L24)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| arg1 | `CodecArg` | -| callback | `CodecCallback` | - -**Returns:** `SubscriptionResult` - -*Defined in [types.ts:25](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L25)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` arg1 | `CodecArg` | -| `Optional` arg2 | `CodecArg` | -| `Optional` arg3 | `CodecArg` | - -**Returns:** `CodecResult` - diff --git a/docs/api/interfaces/_types_.decoratedrpc_section.html b/docs/api/interfaces/_types_.decoratedrpc_section.html deleted file mode 100644 index 9a0d16363e..0000000000 --- a/docs/api/interfaces/_types_.decoratedrpc_section.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.decoratedrpc_section.md b/docs/api/interfaces/_types_.decoratedrpc_section.md deleted file mode 100644 index 0d6720fe39..0000000000 --- a/docs/api/interfaces/_types_.decoratedrpc_section.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**DecoratedRpc$Section** - -# Indexable - -\[index: `string`\]: [DecoratedRpc$Method](_types_.decoratedrpc_method.md)<`CodecResult`, `SubscriptionResult`> diff --git a/docs/api/interfaces/_types_.derive.html b/docs/api/interfaces/_types_.derive.html deleted file mode 100644 index f1e064c104..0000000000 --- a/docs/api/interfaces/_types_.derive.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.derive.md b/docs/api/interfaces/_types_.derive.md deleted file mode 100644 index 4ac9f2bb78..0000000000 --- a/docs/api/interfaces/_types_.derive.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**Derive** - -# Indexable - -\[index: `string`\]: [DeriveSection](_types_.derivesection.md)<`CodecResult`, `SubscriptionResult`> diff --git a/docs/api/interfaces/_types_.derivemethodbase.html b/docs/api/interfaces/_types_.derivemethodbase.html deleted file mode 100644 index 188e688c91..0000000000 --- a/docs/api/interfaces/_types_.derivemethodbase.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.derivemethodbase.md b/docs/api/interfaces/_types_.derivemethodbase.md deleted file mode 100644 index 31dfd3b176..0000000000 --- a/docs/api/interfaces/_types_.derivemethodbase.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**DeriveMethodBase** - -# Callable -▸ **__call**(...params: *`Array`<`CodecArg`>*): `CodecResult` - -*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L88)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` params | `Array`<`CodecArg`> | - -**Returns:** `CodecResult` - diff --git a/docs/api/interfaces/_types_.derivesection.html b/docs/api/interfaces/_types_.derivesection.html deleted file mode 100644 index 0fa548a344..0000000000 --- a/docs/api/interfaces/_types_.derivesection.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.derivesection.md b/docs/api/interfaces/_types_.derivesection.md deleted file mode 100644 index 5dfe3fda12..0000000000 --- a/docs/api/interfaces/_types_.derivesection.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**DeriveSection** - -# Indexable - -\[index: `string`\]: [DeriveMethod](../modules/_types_.md#derivemethod)<`CodecResult`, `SubscriptionResult`> diff --git a/docs/api/interfaces/_types_.queryablemodulestorage.html b/docs/api/interfaces/_types_.queryablemodulestorage.html deleted file mode 100644 index 878c61fbcd..0000000000 --- a/docs/api/interfaces/_types_.queryablemodulestorage.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.queryablemodulestorage.md b/docs/api/interfaces/_types_.queryablemodulestorage.md deleted file mode 100644 index d1a1d8f596..0000000000 --- a/docs/api/interfaces/_types_.queryablemodulestorage.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**QueryableModuleStorage** - -# Indexable - -\[index: `string`\]: [QueryableStorageFunction](../modules/_types_.md#queryablestoragefunction)<`CodecResult`, `SubscriptionResult`> diff --git a/docs/api/interfaces/_types_.queryablestorage.html b/docs/api/interfaces/_types_.queryablestorage.html deleted file mode 100644 index cef0a3ff8b..0000000000 --- a/docs/api/interfaces/_types_.queryablestorage.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.queryablestorage.md b/docs/api/interfaces/_types_.queryablestorage.md deleted file mode 100644 index 252ed38903..0000000000 --- a/docs/api/interfaces/_types_.queryablestorage.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**QueryableStorage** - -# Indexable - -\[index: `string`\]: [QueryableModuleStorage](_types_.queryablemodulestorage.md)<`CodecResult`, `SubscriptionResult`> diff --git a/docs/api/interfaces/_types_.queryablestoragefunctionbase.html b/docs/api/interfaces/_types_.queryablestoragefunctionbase.html deleted file mode 100644 index 49058236e8..0000000000 --- a/docs/api/interfaces/_types_.queryablestoragefunctionbase.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

CodecResult

SubscriptionResult

Hierarchy

StorageFunction

↳ QueryableStorageFunctionBase

Callable

▸ __call(arg?: CodecArg): CodecResult

▸ __call(arg?: any): Uint8Array

Defined in types.ts:50

Parameters:

Name Type
Optional arg CodecArg

Returns: CodecResult

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:12

Parameters:

Name Type
Optional arg any

Returns: Uint8Array

Properties

at

● at: function

Defined in types.ts:52

Type declaration

▸(hash: Hash | Uint8Array | string, arg?: CodecArg): CodecResult

Parameters:

Name Type
hash Hash | Uint8Array | string
Optional arg CodecArg

Returns: CodecResult

hash

● hash: function

Defined in types.ts:53

Type declaration

▸(arg?: CodecArg): HashResult<CodecResult, SubscriptionResult>

Parameters:

Name Type
Optional arg CodecArg

Returns: HashResult<CodecResult, SubscriptionResult>

key

● key: function

Defined in types.ts:54

Type declaration

▸(arg?: CodecArg): string

Parameters:

Name Type
Optional arg CodecArg

Returns: string

meta

● meta: StorageFunctionMetadata

Inherited from StorageFunction.meta

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:14

method

● method: string

Inherited from StorageFunction.method

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:15

section

● section: string

Inherited from StorageFunction.section

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:16

size

● size: function

Defined in types.ts:55

Type declaration

▸(arg?: CodecArg): U64Result<CodecResult, SubscriptionResult>

Parameters:

Name Type
Optional arg CodecArg

Returns: U64Result<CodecResult, SubscriptionResult>

toJSON

● toJSON: function

Inherited from StorageFunction.toJSON

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:17

Type declaration

▸(): any

Returns: any

- - - diff --git a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md b/docs/api/interfaces/_types_.queryablestoragefunctionbase.md deleted file mode 100644 index 3055456adb..0000000000 --- a/docs/api/interfaces/_types_.queryablestoragefunctionbase.md +++ /dev/null @@ -1,169 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - - `StorageFunction` - -**↳ QueryableStorageFunctionBase** - -# Callable -▸ **__call**(arg?: *`CodecArg`*): `CodecResult` - -▸ **__call**(arg?: *`any`*): `Uint8Array` - -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L50)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` arg | `CodecArg` | - -**Returns:** `CodecResult` - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L12)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` arg | `any` | - -**Returns:** `Uint8Array` - -# Properties - - - -## at - -**● at**: *`function`* - -*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L52)* - -#### Type declaration -▸(hash: *`Hash` \| `Uint8Array` \| `string`*, arg?: *`CodecArg`*): `CodecResult` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| hash | `Hash` \| `Uint8Array` \| `string` | -| `Optional` arg | `CodecArg` | - -**Returns:** `CodecResult` - -___ - - -## hash - -**● hash**: *`function`* - -*Defined in [types.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L53)* - -#### Type declaration -▸(arg?: *`CodecArg`*): [HashResult](../modules/_types_.md#hashresult)<`CodecResult`, `SubscriptionResult`> - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` arg | `CodecArg` | - -**Returns:** [HashResult](../modules/_types_.md#hashresult)<`CodecResult`, `SubscriptionResult`> - -___ - - -## key - -**● key**: *`function`* - -*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L54)* - -#### Type declaration -▸(arg?: *`CodecArg`*): `string` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` arg | `CodecArg` | - -**Returns:** `string` - -___ - - -## meta - -**● meta**: *`StorageFunctionMetadata`* - -*Inherited from StorageFunction.meta* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L14)* - -___ - - -## method - -**● method**: *`string`* - -*Inherited from StorageFunction.method* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L15)* - -___ - - -## section - -**● section**: *`string`* - -*Inherited from StorageFunction.section* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L16)* - -___ - - -## size - -**● size**: *`function`* - -*Defined in [types.ts:55](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L55)* - -#### Type declaration -▸(arg?: *`CodecArg`*): [U64Result](../modules/_types_.md#u64result)<`CodecResult`, `SubscriptionResult`> - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` arg | `CodecArg` | - -**Returns:** [U64Result](../modules/_types_.md#u64result)<`CodecResult`, `SubscriptionResult`> - -___ - - -## toJSON - -**● toJSON**: *`function`* - -*Inherited from StorageFunction.toJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L17)* - -#### Type declaration -▸(): `any` - -**Returns:** `any` - -___ - diff --git a/docs/api/interfaces/_types_.signer.html b/docs/api/interfaces/_types_.signer.html deleted file mode 100644 index a75d4d1421..0000000000 --- a/docs/api/interfaces/_types_.signer.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

Signer

Properties

<Optional> update

● update: undefined | function

Defined in types.ts:171

description: Receives an update for the extrinsic signed by a signer.sign

Methods

sign

▸ sign(extrinsic: Extrinsic, address: string, options: SignatureOptions): Promise<number>

Defined in types.ts:166

description: Signs an extrinsic, returning an id (>0) that can be used to retrieve updates

Parameters:

Name Type
extrinsic Extrinsic
address string
options SignatureOptions

Returns: Promise<number>

- - - diff --git a/docs/api/interfaces/_types_.signer.md b/docs/api/interfaces/_types_.signer.md deleted file mode 100644 index 693215ff27..0000000000 --- a/docs/api/interfaces/_types_.signer.md +++ /dev/null @@ -1,44 +0,0 @@ - - -# Hierarchy - -**Signer** - -# Properties - - - -## `` update - -**● update**: *`undefined` \| `function`* - -*Defined in [types.ts:171](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L171)* - -*__description__*: Receives an update for the extrinsic signed by a `signer.sign` - -___ - -# Methods - - - -## sign - -▸ **sign**(extrinsic: *`Extrinsic`*, address: *`string`*, options: *`SignatureOptions`*): `Promise`<`number`> - -*Defined in [types.ts:166](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L166)* - -*__description__*: Signs an extrinsic, returning an id (>0) that can be used to retrieve updates - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| extrinsic | `Extrinsic` | -| address | `string` | -| options | `SignatureOptions` | - -**Returns:** `Promise`<`number`> - -___ - diff --git a/docs/api/interfaces/_types_.submittableextrinsicfunction.html b/docs/api/interfaces/_types_.submittableextrinsicfunction.html deleted file mode 100644 index 86140eab0d..0000000000 --- a/docs/api/interfaces/_types_.submittableextrinsicfunction.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

CodecResult

SubscriptionResult

Hierarchy

MethodFunction

↳ SubmittableExtrinsicFunction

Callable

▸ __call(...params: Array<CodecArg>): SubmittableExtrinsic<CodecResult, SubscriptionResult>

▸ __call(...args: any[]): Method

Defined in types.ts:76

Parameters:

Name Type
Rest params Array<CodecArg>

Returns: SubmittableExtrinsic<CodecResult, SubscriptionResult>

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:28

Parameters:

Name Type
Rest args any[]

Returns: Method

Properties

callIndex

● callIndex: Uint8Array

Inherited from MethodFunction.callIndex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:30

meta

● meta: FunctionMetadata

Inherited from MethodFunction.meta

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:31

method

● method: string

Inherited from MethodFunction.method

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:32

section

● section: string

Inherited from MethodFunction.section

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:33

toJSON

● toJSON: function

Inherited from MethodFunction.toJSON

Defined in /home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:34

Type declaration

▸(): any

Returns: any

- - - diff --git a/docs/api/interfaces/_types_.submittableextrinsicfunction.md b/docs/api/interfaces/_types_.submittableextrinsicfunction.md deleted file mode 100644 index f30fe672f7..0000000000 --- a/docs/api/interfaces/_types_.submittableextrinsicfunction.md +++ /dev/null @@ -1,99 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - - `MethodFunction` - -**↳ SubmittableExtrinsicFunction** - -# Callable -▸ **__call**(...params: *`Array`<`CodecArg`>*): [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`> - -▸ **__call**(...args: *`any`[]*): `Method` - -*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L76)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` params | `Array`<`CodecArg`> | - -**Returns:** [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md)<`CodecResult`, `SubscriptionResult`> - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L28)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` args | `any`[] | - -**Returns:** `Method` - -# Properties - - - -## callIndex - -**● callIndex**: *`Uint8Array`* - -*Inherited from MethodFunction.callIndex* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L30)* - -___ - - -## meta - -**● meta**: *`FunctionMetadata`* - -*Inherited from MethodFunction.meta* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L31)* - -___ - - -## method - -**● method**: *`string`* - -*Inherited from MethodFunction.method* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L32)* - -___ - - -## section - -**● section**: *`string`* - -*Inherited from MethodFunction.section* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L33)* - -___ - - -## toJSON - -**● toJSON**: *`function`* - -*Inherited from MethodFunction.toJSON* - -*Defined in [/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L34)* - -#### Type declaration -▸(): `any` - -**Returns:** `any` - -___ - diff --git a/docs/api/interfaces/_types_.submittableextrinsics.html b/docs/api/interfaces/_types_.submittableextrinsics.html deleted file mode 100644 index 72428f00d7..0000000000 --- a/docs/api/interfaces/_types_.submittableextrinsics.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.submittableextrinsics.md b/docs/api/interfaces/_types_.submittableextrinsics.md deleted file mode 100644 index 5f76caed18..0000000000 --- a/docs/api/interfaces/_types_.submittableextrinsics.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**SubmittableExtrinsics** - -# Indexable - -\[index: `string`\]: [SubmittableModuleExtrinsics](_types_.submittablemoduleextrinsics.md)<`CodecResult`, `SubscriptionResult`> diff --git a/docs/api/interfaces/_types_.submittablemoduleextrinsics.html b/docs/api/interfaces/_types_.submittablemoduleextrinsics.html deleted file mode 100644 index ceda0f864f..0000000000 --- a/docs/api/interfaces/_types_.submittablemoduleextrinsics.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/interfaces/_types_.submittablemoduleextrinsics.md b/docs/api/interfaces/_types_.submittablemoduleextrinsics.md deleted file mode 100644 index 9246960dc9..0000000000 --- a/docs/api/interfaces/_types_.submittablemoduleextrinsics.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Type parameters -#### CodecResult -#### SubscriptionResult -# Hierarchy - -**SubmittableModuleExtrinsics** - -# Indexable - -\[index: `string`\]: [SubmittableExtrinsicFunction](_types_.submittableextrinsicfunction.md)<`CodecResult`, `SubscriptionResult`> diff --git a/docs/api/modules/_base_.html b/docs/api/modules/_base_.html deleted file mode 100644 index b8ca830fae..0000000000 --- a/docs/api/modules/_base_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_base_.md b/docs/api/modules/_base_.md deleted file mode 100644 index 4e6114961b..0000000000 --- a/docs/api/modules/_base_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ApiBase](../classes/_base_.apibase.md) - ---- - diff --git a/docs/api/modules/_checktypes_manual_.html b/docs/api/modules/_checktypes_manual_.html deleted file mode 100644 index 6a04bfa311..0000000000 --- a/docs/api/modules/_checktypes_manual_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_checktypes_manual_.md b/docs/api/modules/_checktypes_manual_.md deleted file mode 100644 index a6c254ad76..0000000000 --- a/docs/api/modules/_checktypes_manual_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Functions - - - -## test - -▸ **test**(): `Promise`<`void`> - -*Defined in [checkTypes.manual.ts:11](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/checkTypes.manual.ts#L11)* - -**Returns:** `Promise`<`void`> - -___ - diff --git a/docs/api/modules/_promise_api_.html b/docs/api/modules/_promise_api_.html deleted file mode 100644 index 36be4ff31f..0000000000 --- a/docs/api/modules/_promise_api_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_promise_api_.md b/docs/api/modules/_promise_api_.md deleted file mode 100644 index f47f839bd4..0000000000 --- a/docs/api/modules/_promise_api_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ApiPromise](../classes/_promise_api_.apipromise.md) - ---- - diff --git a/docs/api/modules/_promise_combinator_.html b/docs/api/modules/_promise_combinator_.html deleted file mode 100644 index c1f566f2ff..0000000000 --- a/docs/api/modules/_promise_combinator_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_promise_combinator_.md b/docs/api/modules/_promise_combinator_.md deleted file mode 100644 index ddef2b9b5a..0000000000 --- a/docs/api/modules/_promise_combinator_.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Index - -### Classes - -* [Combinator](../classes/_promise_combinator_.combinator.md) - -### Type aliases - -* [CombinatorCallback](_promise_combinator_.md#combinatorcallback) -* [CombinatorFunction](_promise_combinator_.md#combinatorfunction) - ---- - -# Type aliases - - - -## CombinatorCallback - -**Ƭ CombinatorCallback**: *`function`* - -*Defined in [promise/Combinator.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L9)* - -#### Type declaration -▸(value: *`Array`<`any`>*): `any` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `Array`<`any`> | - -**Returns:** `any` - -___ - - -## CombinatorFunction - -**Ƭ CombinatorFunction**: *`function`* - -*Defined in [promise/Combinator.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L10)* - -#### Type declaration -▸(cb: *`function`*): [SubscriptionResult]() - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| cb | `function` | - -**Returns:** [SubscriptionResult]() - -___ - diff --git a/docs/api/modules/_promise_types_.html b/docs/api/modules/_promise_types_.html deleted file mode 100644 index 7b7d0a4b6d..0000000000 --- a/docs/api/modules/_promise_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_promise_types_.md b/docs/api/modules/_promise_types_.md deleted file mode 100644 index 63fcfda5b7..0000000000 --- a/docs/api/modules/_promise_types_.md +++ /dev/null @@ -1,66 +0,0 @@ - - -# Index - -### Interfaces - -* [ApiPromiseInterface](../interfaces/_promise_types_.apipromiseinterface.md) - -### Type aliases - -* [CodecResult](_promise_types_.md#codecresult) -* [QueryableStorageFunction](_promise_types_.md#queryablestoragefunction) -* [SubmittableExtrinsic](_promise_types_.md#submittableextrinsic) -* [SubmittableExtrinsicFunction](_promise_types_.md#submittableextrinsicfunction) -* [SubscriptionResult](_promise_types_.md#subscriptionresult) - ---- - -# Type aliases - - - -## CodecResult - -**Ƭ CodecResult**: *`Promise`<`Codec`>* - -*Defined in [promise/types.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L13)* - -___ - - -## QueryableStorageFunction - -**Ƭ QueryableStorageFunction**: *[QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md)<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* - -*Defined in [promise/types.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L19)* - -___ - - -## SubmittableExtrinsic - -**Ƭ SubmittableExtrinsic**: *`SubmittableExtrinsicBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* - -*Defined in [promise/types.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L20)* - -___ - - -## SubmittableExtrinsicFunction - -**Ƭ SubmittableExtrinsicFunction**: *`SubmittableExtrinsicFunctionBase`<[CodecResult](_promise_types_.md#codecresult), [SubscriptionResult](_promise_types_.md#subscriptionresult)>* - -*Defined in [promise/types.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L21)* - -___ - - -## SubscriptionResult - -**Ƭ SubscriptionResult**: *`Promise`<`function`>* - -*Defined in [promise/types.ts:11](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L11)* - -___ - diff --git a/docs/api/modules/_rx_api_.html b/docs/api/modules/_rx_api_.html deleted file mode 100644 index 85e55c8065..0000000000 --- a/docs/api/modules/_rx_api_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_rx_api_.md b/docs/api/modules/_rx_api_.md deleted file mode 100644 index 26e329e360..0000000000 --- a/docs/api/modules/_rx_api_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ApiRx](../classes/_rx_api_.apirx.md) - ---- - diff --git a/docs/api/modules/_rx_types_.html b/docs/api/modules/_rx_types_.html deleted file mode 100644 index c2931733a5..0000000000 --- a/docs/api/modules/_rx_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_rx_types_.md b/docs/api/modules/_rx_types_.md deleted file mode 100644 index d9b6009fac..0000000000 --- a/docs/api/modules/_rx_types_.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# Index - -### Interfaces - -* [ApiRxInterface](../interfaces/_rx_types_.apirxinterface.md) - -### Type aliases - -* [RxResult](_rx_types_.md#rxresult) - ---- - -# Type aliases - - - -## RxResult - -**Ƭ RxResult**: *`Observable`<`Codec`>* - -*Defined in [rx/types.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/types.ts#L10)* - -___ - diff --git a/docs/api/modules/_submittableextrinsic_.html b/docs/api/modules/_submittableextrinsic_.html deleted file mode 100644 index aad0028a52..0000000000 --- a/docs/api/modules/_submittableextrinsic_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_submittableextrinsic_.md b/docs/api/modules/_submittableextrinsic_.md deleted file mode 100644 index 371212956b..0000000000 --- a/docs/api/modules/_submittableextrinsic_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Classes - -* [SubmittableExtrinsic](../classes/_submittableextrinsic_.submittableextrinsic.md) -* [SubmittableResult](../classes/_submittableextrinsic_.submittableresult.md) - ---- - diff --git a/docs/api/modules/_types_.html b/docs/api/modules/_types_.html deleted file mode 100644 index f507e1f3f4..0000000000 --- a/docs/api/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - -
polkadot-js/api

Index

Interfaces

Type aliases

Type aliases

ApiInterface$Events

Ƭ ApiInterface$Events: RpcRxInterface$Events | "ready"

Defined in types.ts:151

ApiInterface$Rx

Ƭ ApiInterface$Rx: ApiInterface$Decorated<RxResult, RxResult>

Defined in types.ts:149

ApiType

Ƭ ApiType: "promise" | "rxjs"

Defined in types.ts:153

DeriveMethod

Ƭ DeriveMethod: DeriveMethod<CodecResult, SubscriptionResult>

Defined in types.ts:99

HashResult

Ƭ HashResult: HashResult<CodecResult, SubscriptionResult>

Defined in types.ts:40

OnCallDefinition

Ƭ OnCallDefinition: function

Defined in types.ts:18

Type declaration

▸(method: OnCallFunction<RxResult, RxResult>, params?: Array<CodecArg>, callback?: CodecCallback, needsCallback?: undefined | false | true): CodecResult | SubscriptionResult

Parameters:

Name Type
method OnCallFunction<RxResult, RxResult>
Optional params Array<CodecArg>
Optional callback CodecCallback
Optional needsCallback undefined | false | true

Returns: CodecResult | SubscriptionResult

OnCallFunction

Ƭ OnCallFunction: function

Defined in types.ts:20

Type declaration

▸(...params: Array<CodecArg>): CodecResult | SubscriptionResult

Parameters:

Name Type
Rest params Array<CodecArg>

Returns: CodecResult | SubscriptionResult

QueryableStorageFunction

Ƭ QueryableStorageFunction: QueryableStorageFunction<CodecResult, SubscriptionResult>

Defined in types.ts:63

U64Result

Ƭ U64Result: U64Result<CodecResult, SubscriptionResult>

Defined in types.ts:45

- - - diff --git a/docs/api/modules/_types_.md b/docs/api/modules/_types_.md deleted file mode 100644 index 952fc42124..0000000000 --- a/docs/api/modules/_types_.md +++ /dev/null @@ -1,146 +0,0 @@ - - -# Index - -### Interfaces - -* [ApiBaseInterface](../interfaces/_types_.apibaseinterface.md) -* [ApiInterface$Decorated](../interfaces/_types_.apiinterface_decorated.md) -* [ApiOptions](../interfaces/_types_.apioptions.md) -* [DecoratedRpc](../interfaces/_types_.decoratedrpc.md) -* [DecoratedRpc$Method](../interfaces/_types_.decoratedrpc_method.md) -* [DecoratedRpc$Section](../interfaces/_types_.decoratedrpc_section.md) -* [Derive](../interfaces/_types_.derive.md) -* [DeriveMethodBase](../interfaces/_types_.derivemethodbase.md) -* [DeriveSection](../interfaces/_types_.derivesection.md) -* [QueryableModuleStorage](../interfaces/_types_.queryablemodulestorage.md) -* [QueryableStorage](../interfaces/_types_.queryablestorage.md) -* [QueryableStorageFunctionBase](../interfaces/_types_.queryablestoragefunctionbase.md) -* [Signer](../interfaces/_types_.signer.md) -* [SubmittableExtrinsicFunction](../interfaces/_types_.submittableextrinsicfunction.md) -* [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md) -* [SubmittableModuleExtrinsics](../interfaces/_types_.submittablemoduleextrinsics.md) - -### Type aliases - -* [ApiInterface$Events](_types_.md#apiinterface_events) -* [ApiInterface$Rx](_types_.md#apiinterface_rx) -* [ApiType](_types_.md#apitype) -* [DeriveMethod](_types_.md#derivemethod) -* [HashResult](_types_.md#hashresult) -* [OnCallDefinition](_types_.md#oncalldefinition) -* [OnCallFunction](_types_.md#oncallfunction) -* [QueryableStorageFunction](_types_.md#queryablestoragefunction) -* [U64Result](_types_.md#u64result) - ---- - -# Type aliases - - - -## ApiInterface$Events - -**Ƭ ApiInterface$Events**: *`RpcRxInterface$Events` \| "ready"* - -*Defined in [types.ts:151](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L151)* - -___ - - -## ApiInterface$Rx - -**Ƭ ApiInterface$Rx**: *[ApiInterface$Decorated](../interfaces/_types_.apiinterface_decorated.md)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>* - -*Defined in [types.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L149)* - -___ - - -## ApiType - -**Ƭ ApiType**: *"promise" \| "rxjs"* - -*Defined in [types.ts:153](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L153)* - -___ - - -## DeriveMethod - -**Ƭ DeriveMethod**: *`DeriveMethod`* - -*Defined in [types.ts:99](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L99)* - -___ - - -## HashResult - -**Ƭ HashResult**: *`HashResult`* - -*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L40)* - -___ - - -## OnCallDefinition - -**Ƭ OnCallDefinition**: *`function`* - -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L18)* - -#### Type declaration -▸(method: *[OnCallFunction](_types_.md#oncallfunction)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)>*, params?: *`Array`<`CodecArg`>*, callback?: *`CodecCallback`*, needsCallback?: *`undefined` \| `false` \| `true`*): `CodecResult` \| `SubscriptionResult` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| method | [OnCallFunction](_types_.md#oncallfunction)<[RxResult](_rx_types_.md#rxresult), [RxResult](_rx_types_.md#rxresult)> | -| `Optional` params | `Array`<`CodecArg`> | -| `Optional` callback | `CodecCallback` | -| `Optional` needsCallback | `undefined` \| `false` \| `true` | - -**Returns:** `CodecResult` \| `SubscriptionResult` - -___ - - -## OnCallFunction - -**Ƭ OnCallFunction**: *`function`* - -*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L20)* - -#### Type declaration -▸(...params: *`Array`<`CodecArg`>*): `CodecResult` \| `SubscriptionResult` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` params | `Array`<`CodecArg`> | - -**Returns:** `CodecResult` \| `SubscriptionResult` - -___ - - -## QueryableStorageFunction - -**Ƭ QueryableStorageFunction**: *`QueryableStorageFunction`* - -*Defined in [types.ts:63](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L63)* - -___ - - -## U64Result - -**Ƭ U64Result**: *`U64Result`* - -*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L45)* - -___ - diff --git a/docs/api/modules/_util_filterevents_.html b/docs/api/modules/_util_filterevents_.html deleted file mode 100644 index fe1d7d6a66..0000000000 --- a/docs/api/modules/_util_filterevents_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_util_filterevents_.md b/docs/api/modules/_util_filterevents_.md deleted file mode 100644 index 9eacbbb3de..0000000000 --- a/docs/api/modules/_util_filterevents_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## filterEvents - -▸ **filterEvents**(extHash: *`Hash`*, __namedParameters: *`object`*, allEvents: *`Array`<`EventRecord`>*): `Array`<`EventRecord`> \| `undefined` - -*Defined in [util/filterEvents.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/util/filterEvents.ts#L9)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| extHash | `Hash` | -| __namedParameters | `object` | -| allEvents | `Array`<`EventRecord`> | - -**Returns:** `Array`<`EventRecord`> \| `undefined` - -___ - diff --git a/docs/api/modules/_util_logging_.html b/docs/api/modules/_util_logging_.html deleted file mode 100644 index cfb685c166..0000000000 --- a/docs/api/modules/_util_logging_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/api/modules/_util_logging_.md b/docs/api/modules/_util_logging_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/api/modules/_util_logging_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/assets/css/0.styles.22f13802.css b/docs/assets/css/0.styles.22f13802.css deleted file mode 100644 index f8da214875..0000000000 --- a/docs/assets/css/0.styles.22f13802.css +++ /dev/null @@ -1 +0,0 @@ -#nprogress{pointer-events:none}#nprogress .bar{background:#fd8824;position:fixed;z-index:1031;top:0;left:0;width:100%;height:2px}#nprogress .peg{display:block;position:absolute;right:0;width:100px;height:100%;-webkit-box-shadow:0 0 10px #fd8824,0 0 5px #fd8824;box-shadow:0 0 10px #fd8824,0 0 5px #fd8824;opacity:1;-webkit-transform:rotate(3deg) translateY(-4px);transform:rotate(3deg) translateY(-4px)}#nprogress .spinner{display:block;position:fixed;z-index:1031;top:15px;right:15px}#nprogress .spinner-icon{width:18px;height:18px;-webkit-box-sizing:border-box;box-sizing:border-box;border:2px solid transparent;border-top-color:#fd8824;border-left-color:#fd8824;border-radius:50%;-webkit-animation:nprogress-spinner .4s linear infinite;animation:nprogress-spinner .4s linear infinite}.nprogress-custom-parent{overflow:hidden;position:relative}.nprogress-custom-parent #nprogress .bar,.nprogress-custom-parent #nprogress .spinner{position:absolute}@-webkit-keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}@keyframes nprogress-spinner{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(1turn);transform:rotate(1turn)}}.icon.outbound{color:#aaa;display:inline-block;vertical-align:middle;position:relative;top:-1px}.home{padding:3.6rem 2rem 0;max-width:960px;margin:0 auto;display:block}.home .hero{text-align:center}.home .hero img{max-width:100%;max-height:280px;display:block;margin:3rem auto 1.5rem}.home .hero h1{font-size:3rem}.home .hero .action,.home .hero .description,.home .hero h1{margin:1.8rem auto}.home .hero .description{max-width:35rem;font-size:1.6rem;line-height:1.3;color:#6a8bad}.home .hero .action-button{display:inline-block;font-size:1.2rem;color:#fff;background-color:#fd8824;padding:.8rem 1.6rem;border-radius:4px;-webkit-transition:background-color .1s ease;transition:background-color .1s ease;-webkit-box-sizing:border-box;box-sizing:border-box;border-bottom:1px solid #fd7807}.home .hero .action-button:hover{background-color:#fd943a}.home .features{border-top:1px solid #eaecef;padding:1.2rem 0;margin-top:2.5rem;display:-webkit-box;display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start;-ms-flex-line-pack:stretch;align-content:stretch;-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.home .feature{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:30%;flex-basis:30%;max-width:30%}.home .feature h2{font-size:1.4rem;font-weight:500;border-bottom:none;padding-bottom:0;color:#3a5169}.home .feature p{color:#4e6e8e}.home .footer{padding:2.5rem;border-top:1px solid #eaecef;text-align:center;color:#4e6e8e}@media (max-width:719px){.home .features{-webkit-box-orient:vertical;-webkit-box-direction:normal;-ms-flex-direction:column;flex-direction:column}.home .feature{max-width:100%;padding:0 2.5rem}}@media (max-width:419px){.home{padding-left:1.5rem;padding-right:1.5rem}.home .hero img{max-height:210px;margin:2rem auto 1.2rem}.home .hero h1{font-size:2rem}.home .hero .action,.home .hero .description,.home .hero h1{margin:1.2rem auto}.home .hero .description{font-size:1.2rem}.home .hero .action-button{font-size:1rem;padding:.6rem 1.2rem}.home .feature h2{font-size:1.25rem}}.search-box{display:inline-block;position:relative;margin-right:1rem}.search-box input{cursor:text;width:10rem;height:2rem;color:#4e6e8e;display:inline-block;border:1px solid #cfd4db;border-radius:2rem;font-size:.9rem;line-height:2rem;padding:0 .5rem 0 2rem;outline:none;-webkit-transition:all .2s ease;transition:all .2s ease;background:#fff url(/api/assets/img/search.83621669.svg) .6rem .5rem no-repeat;background-size:1rem}.search-box input:focus{cursor:auto;border-color:#fd8824}.search-box .suggestions{background:#fff;width:20rem;position:absolute;top:1.5rem;border:1px solid #cfd4db;border-radius:6px;padding:.4rem;list-style-type:none}.search-box .suggestions.align-right{right:0}.search-box .suggestion{line-height:1.4;padding:.4rem .6rem;border-radius:4px;cursor:pointer}.search-box .suggestion a{white-space:normal;color:#5d82a6}.search-box .suggestion a .page-title{font-weight:600}.search-box .suggestion a .header{font-size:.9em;margin-left:.25em}.search-box .suggestion.focused{background-color:#f3f4f5}.search-box .suggestion.focused a{color:#fd8824}@media (max-width:959px){.search-box input{cursor:pointer;width:0;border-color:transparent;position:relative}.search-box input:focus{cursor:text;left:0;width:10rem}}@media (-ms-high-contrast:none){.search-box input{height:2rem}}@media (max-width:959px) and (min-width:719px){.search-box .suggestions{left:0}}@media (max-width:719px){.search-box{margin-right:0}.search-box input{left:1rem}.search-box .suggestions{right:0}}@media (max-width:419px){.search-box .suggestions{width:calc(100vw - 4rem)}.search-box input:focus{width:8rem}}.sidebar-button{cursor:pointer;display:none;width:1.25rem;height:1.25rem;position:absolute;padding:.6rem;top:.6rem;left:1rem}.sidebar-button .icon{display:block;width:1.25rem;height:1.25rem}@media (max-width:719px){.sidebar-button{display:block}}.dropdown-enter,.dropdown-leave-to{height:0!important}.dropdown-wrapper{cursor:pointer}.dropdown-wrapper .dropdown-title{display:block}.dropdown-wrapper .dropdown-title:hover{border-color:transparent}.dropdown-wrapper .dropdown-title .arrow{vertical-align:middle;margin-top:-1px;margin-left:.4rem}.dropdown-wrapper .nav-dropdown .dropdown-item{color:inherit;line-height:1.7rem}.dropdown-wrapper .nav-dropdown .dropdown-item h4{margin:.45rem 0 0;border-top:1px solid #eee;padding:.45rem 1.5rem 0 1.25rem}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem-wrapper{padding:0;list-style:none}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem-wrapper .dropdown-subitem{font-size:.9em}.dropdown-wrapper .nav-dropdown .dropdown-item a{display:block;line-height:1.7rem;position:relative;border-bottom:none;font-weight:400;margin-bottom:0;padding:0 1.5rem 0 1.25rem}.dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active,.dropdown-wrapper .nav-dropdown .dropdown-item a:hover{color:#fd8824}.dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active:after{content:"";width:0;height:0;border-left:5px solid #fd8824;border-top:3px solid transparent;border-bottom:3px solid transparent;position:absolute;top:calc(50% - 2px);left:9px}.dropdown-wrapper .nav-dropdown .dropdown-item:first-child h4{margin-top:0;padding-top:0;border-top:0}@media (max-width:719px){.dropdown-wrapper.open .dropdown-title{margin-bottom:.5rem}.dropdown-wrapper .nav-dropdown{-webkit-transition:height .1s ease-out;transition:height .1s ease-out;overflow:hidden}.dropdown-wrapper .nav-dropdown .dropdown-item h4{border-top:0;margin-top:0;padding-top:0}.dropdown-wrapper .nav-dropdown .dropdown-item>a,.dropdown-wrapper .nav-dropdown .dropdown-item h4{font-size:15px;line-height:2rem}.dropdown-wrapper .nav-dropdown .dropdown-item .dropdown-subitem{font-size:14px;padding-left:1rem}}@media (min-width:719px){.dropdown-wrapper{height:1.8rem}.dropdown-wrapper:hover .nav-dropdown{display:block!important}.dropdown-wrapper .dropdown-title .arrow{border-left:4px solid transparent;border-right:4px solid transparent;border-top:6px solid #ccc;border-bottom:0}.dropdown-wrapper .nav-dropdown{display:none;height:auto!important;-webkit-box-sizing:border-box;box-sizing:border-box;max-height:calc(100vh - 2.7rem);overflow-y:auto;position:absolute;top:100%;right:0;background-color:#fff;padding:.6rem 0;border:1px solid #ddd;border-bottom-color:#ccc;text-align:left;border-radius:.25rem;white-space:nowrap;margin:0}}.nav-links{display:inline-block}.nav-links a{line-height:1.4rem;color:inherit}.nav-links a.router-link-active,.nav-links a:hover{color:#fd8824}.nav-links .nav-item{position:relative;display:inline-block;margin-left:1.5rem;line-height:2rem}.nav-links .nav-item:first-child{margin-left:0}.nav-links .repo-link{margin-left:1.5rem}@media (max-width:719px){.nav-links .nav-item,.nav-links .repo-link{margin-left:0}}@media (min-width:719px){.nav-links a.router-link-active,.nav-links a:hover{color:#2c3e50}.nav-item>a:not(.external).router-link-active,.nav-item>a:not(.external):hover{margin-bottom:-2px;border-bottom:2px solid #fd9236}}.navbar{padding:.7rem 1.5rem;line-height:2.2rem}.navbar a,.navbar img,.navbar span{display:inline-block}.navbar .logo{height:2.2rem;min-width:2.2rem;margin-right:.8rem;vertical-align:top}.navbar .site-name{font-size:1.3rem;font-weight:600;color:#2c3e50;position:relative}.navbar .links{padding-left:1.5rem;-webkit-box-sizing:border-box;box-sizing:border-box;background-color:#fff;white-space:nowrap;font-size:.9rem;position:absolute;right:1.5rem;top:.7rem;display:-webkit-box;display:-ms-flexbox;display:flex}.navbar .links .search-box{-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;vertical-align:top}@media (max-width:719px){.navbar{padding-left:4rem}.navbar .can-hide{display:none}.navbar .links{padding-left:1.5rem}}.page-edit,.page-nav{max-width:740px;margin:0 auto;padding:2rem 2.5rem}@media (max-width:959px){.page-edit,.page-nav{padding:2rem}}@media (max-width:419px){.page-edit,.page-nav{padding:1.5rem}}.page{padding-bottom:2rem;display:block}.page-edit{padding-top:1rem;padding-bottom:1rem;overflow:auto}.page-edit .edit-link{display:inline-block}.page-edit .edit-link a{color:#4e6e8e;margin-right:.25rem}.page-edit .last-updated{float:right;font-size:.9em}.page-edit .last-updated .prefix{font-weight:500;color:#4e6e8e}.page-edit .last-updated .time{font-weight:400;color:#aaa}.page-nav{padding-top:1rem;padding-bottom:0}.page-nav .inner{min-height:2rem;margin-top:0;border-top:1px solid #eaecef;padding-top:1rem;overflow:auto}.page-nav .next{float:right}@media (max-width:719px){.page-edit .edit-link{margin-bottom:.5rem}.page-edit .last-updated{font-size:.8em;float:none;text-align:left}}.sidebar-group .sidebar-group{padding-left:.5em}.sidebar-group:not(.collapsable) .sidebar-heading:not(.clickable){cursor:auto;color:inherit}.sidebar-group.is-sub-group{padding-left:0}.sidebar-group.is-sub-group>.sidebar-heading{font-size:.95em;line-height:1.4;font-weight:400;padding-left:2rem}.sidebar-group.is-sub-group>.sidebar-heading:not(.clickable){opacity:.5}.sidebar-group.is-sub-group>.sidebar-group-items{padding-left:1rem}.sidebar-group.is-sub-group>.sidebar-group-items>li>.sidebar-link{font-size:.95em;border-left:none}.sidebar-group.depth-2>.sidebar-heading{border-left:none}.sidebar-heading{color:#2c3e50;-webkit-transition:color .15s ease;transition:color .15s ease;cursor:pointer;font-size:1.1em;font-weight:700;padding:.35rem 1.5rem .35rem 1.25rem;width:100%;-webkit-box-sizing:border-box;box-sizing:border-box;margin:0;border-left:.25rem solid transparent}.sidebar-heading.open,.sidebar-heading:hover{color:inherit}.sidebar-heading .arrow{position:relative;top:-.12em;left:.5em}.sidebar-heading.clickable.active{font-weight:600;color:#fd8824;border-left-color:#fd8824}.sidebar-heading.clickable:hover{color:#fd8824}.sidebar-group-items{-webkit-transition:height .1s ease-out;transition:height .1s ease-out;font-size:.95em;overflow:hidden}.sidebar .sidebar-sub-headers{padding-left:1rem;font-size:.95em}a.sidebar-link{font-size:1em;font-weight:400;display:inline-block;color:#2c3e50;border-left:.25rem solid transparent;padding:.35rem 1rem .35rem 1.25rem;line-height:1.4;width:100%;-webkit-box-sizing:border-box;box-sizing:border-box}a.sidebar-link:hover{color:#fd8824}a.sidebar-link.active{font-weight:600;color:#fd8824;border-left-color:#fd8824}.sidebar-group a.sidebar-link{padding-left:2rem}.sidebar-sub-headers a.sidebar-link{padding-top:.25rem;padding-bottom:.25rem;border-left:none}.sidebar-sub-headers a.sidebar-link.active{font-weight:500}.sidebar ul{padding:0;margin:0;list-style-type:none}.sidebar a{display:inline-block}.sidebar .nav-links{display:none;border-bottom:1px solid #eaecef;padding:.5rem 0 .75rem 0}.sidebar .nav-links a{font-weight:600}.sidebar .nav-links .nav-item,.sidebar .nav-links .repo-link{display:block;line-height:1.25rem;font-size:1.1em;padding:.5rem 0 .5rem 1.5rem}.sidebar>.sidebar-links{padding:1.5rem 0}.sidebar>.sidebar-links>li>a.sidebar-link{font-size:1.1em;line-height:1.7;font-weight:700}.sidebar>.sidebar-links>li:not(:first-child){margin-top:.75rem}@media (max-width:719px){.sidebar .nav-links{display:block}.sidebar .nav-links .dropdown-wrapper .nav-dropdown .dropdown-item a.router-link-active:after{top:calc(1rem - 2px)}.sidebar>.sidebar-links{padding:1rem 0}}code[class*=language-],pre[class*=language-]{color:#ccc;background:none;font-family:Consolas,Monaco,Andale Mono,Ubuntu Mono,monospace;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.block-comment,.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#999}.token.punctuation{color:#ccc}.token.attr-name,.token.deleted,.token.namespace,.token.tag{color:#e2777a}.token.function-name{color:#6196cc}.token.boolean,.token.function,.token.number{color:#f08d49}.token.class-name,.token.constant,.token.property,.token.symbol{color:#f8c555}.token.atrule,.token.builtin,.token.important,.token.keyword,.token.selector{color:#cc99cd}.token.attr-value,.token.char,.token.regex,.token.string,.token.variable{color:#7ec699}.token.entity,.token.operator,.token.url{color:#67cdcc}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:green}.content code{color:#476582;padding:.25rem .5rem;margin:0;font-size:.85em;background-color:rgba(27,31,35,.05);border-radius:3px}.content code .token.deleted{color:#ec5975}.content code .token.inserted{color:#fd8824}.content pre,.content pre[class*=language-]{line-height:1.4;padding:1.25rem 1.5rem;margin:.85rem 0;background-color:#282c34;border-radius:6px;overflow:auto}.content pre[class*=language-] code,.content pre code{color:#fff;padding:0;background-color:transparent;border-radius:0}div[class*=language-]{position:relative;background-color:#282c34;border-radius:6px}div[class*=language-] .highlight-lines{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;padding-top:1.3rem;position:absolute;top:0;left:0;width:100%;line-height:1.4}div[class*=language-] .highlight-lines .highlighted{background-color:rgba(0,0,0,.66)}div[class*=language-] pre,div[class*=language-] pre[class*=language-]{background:transparent;position:relative;z-index:1}div[class*=language-]:before{position:absolute;z-index:3;top:.8em;right:1em;font-size:.75rem;color:hsla(0,0%,100%,.4)}div[class*=language-]:not(.line-numbers-mode) .line-numbers-wrapper{display:none}div[class*=language-].line-numbers-mode .highlight-lines .highlighted{position:relative}div[class*=language-].line-numbers-mode .highlight-lines .highlighted:before{content:" ";position:absolute;z-index:3;left:0;top:0;display:block;width:3.5rem;height:100%;background-color:rgba(0,0,0,.66)}div[class*=language-].line-numbers-mode pre{padding-left:4.5rem;vertical-align:middle}div[class*=language-].line-numbers-mode .line-numbers-wrapper{position:absolute;top:0;width:3.5rem;text-align:center;color:hsla(0,0%,100%,.3);padding:1.25rem 0;line-height:1.4}div[class*=language-].line-numbers-mode .line-numbers-wrapper .line-number,div[class*=language-].line-numbers-mode .line-numbers-wrapper br{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}div[class*=language-].line-numbers-mode .line-numbers-wrapper .line-number{position:relative;z-index:4;font-size:.85em}div[class*=language-].line-numbers-mode:after{content:"";position:absolute;z-index:2;top:0;left:0;width:3.5rem;height:100%;border-radius:6px 0 0 6px;border-right:1px solid rgba(0,0,0,.66);background-color:#282c34}div[class~=language-js]:before{content:"js"}div[class~=language-ts]:before{content:"ts"}div[class~=language-html]:before{content:"html"}div[class~=language-md]:before{content:"md"}div[class~=language-vue]:before{content:"vue"}div[class~=language-css]:before{content:"css"}div[class~=language-sass]:before{content:"sass"}div[class~=language-scss]:before{content:"scss"}div[class~=language-less]:before{content:"less"}div[class~=language-stylus]:before{content:"stylus"}div[class~=language-go]:before{content:"go"}div[class~=language-java]:before{content:"java"}div[class~=language-c]:before{content:"c"}div[class~=language-sh]:before{content:"sh"}div[class~=language-yaml]:before{content:"yaml"}div[class~=language-py]:before{content:"py"}div[class~=language-docker]:before{content:"docker"}div[class~=language-dockerfile]:before{content:"dockerfile"}div[class~=language-makefile]:before{content:"makefile"}div[class~=language-javascript]:before{content:"js"}div[class~=language-typescript]:before{content:"ts"}div[class~=language-markup]:before{content:"html"}div[class~=language-markdown]:before{content:"md"}div[class~=language-json]:before{content:"json"}div[class~=language-ruby]:before{content:"rb"}div[class~=language-python]:before{content:"py"}div[class~=language-bash]:before{content:"sh"}div[class~=language-php]:before{content:"php"}.custom-block .custom-block-title{font-weight:600;margin-bottom:-.4rem}.custom-block.danger,.custom-block.tip,.custom-block.warning{padding:.1rem 1.5rem;border-left-width:.5rem;border-left-style:solid;margin:1rem 0}.custom-block.tip{background-color:#f3f5f7;border-color:#42b983}.custom-block.warning{background-color:rgba(255,229,100,.3);border-color:#e7c000;color:#6b5900}.custom-block.warning .custom-block-title{color:#b29400}.custom-block.warning a{color:#2c3e50}.custom-block.danger{background-color:#ffe6e6;border-color:#c00;color:#4d0000}.custom-block.danger .custom-block-title{color:#900}.custom-block.danger a{color:#2c3e50}pre.vue-container{border-left-width:.5rem;border-left-style:solid;border-color:#42b983;border-radius:0}pre.vue-container>code{font-size:14px!important}pre.vue-container>code>p{margin:-5px 0 -20px 0}pre.vue-container>code code{background-color:#42b983!important;padding:3px 5px;border-radius:3px;color:#000}pre.vue-container>code em{color:gray;font-weight:light}.arrow{display:inline-block;width:0;height:0}.arrow.up{border-bottom:6px solid #ccc}.arrow.down,.arrow.up{border-left:4px solid transparent;border-right:4px solid transparent}.arrow.down{border-top:6px solid #ccc}.arrow.right{border-left:6px solid #ccc}.arrow.left,.arrow.right{border-top:4px solid transparent;border-bottom:4px solid transparent}.arrow.left{border-right:6px solid #ccc}.content:not(.custom){max-width:740px;margin:0 auto;padding:2rem 2.5rem}@media (max-width:959px){.content:not(.custom){padding:2rem}}@media (max-width:419px){.content:not(.custom){padding:1.5rem}}.table-of-contents .badge{vertical-align:middle}body,html{padding:0;margin:0;background-color:#fff}body{font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Fira Sans,Droid Sans,Helvetica Neue,sans-serif;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-size:16px;color:#2c3e50}.page{padding-left:20rem}.navbar{z-index:20;right:0;height:3.6rem;background-color:#fff;-webkit-box-sizing:border-box;box-sizing:border-box;border-bottom:1px solid #eaecef}.navbar,.sidebar-mask{position:fixed;top:0;left:0}.sidebar-mask{z-index:9;width:100vw;height:100vh;display:none}.sidebar{font-size:16px;background-color:#fff;width:20rem;position:fixed;z-index:10;margin:0;top:3.6rem;left:0;bottom:0;-webkit-box-sizing:border-box;box-sizing:border-box;border-right:1px solid #eaecef;overflow-y:auto}.content:not(.custom)>:first-child{margin-top:3.6rem}.content:not(.custom) a:hover{text-decoration:underline}.content:not(.custom) p.demo{padding:1rem 1.5rem;border:1px solid #ddd;border-radius:4px}.content:not(.custom) img{max-width:100%}.content.custom{padding:0;margin:0}.content.custom img{max-width:100%}a{font-weight:500;text-decoration:none}a,p a code{color:#fd8824}p a code{font-weight:400}kbd{background:#eee;border:.15rem solid #ddd;border-bottom:.25rem solid #ddd;border-radius:.15rem;padding:0 .15em}blockquote{font-size:.9rem;color:#999;border-left:.5rem solid #dfe2e5;margin:.5rem 0;padding:.25rem 0 .25rem 1rem}blockquote>p{margin:0}ol,ul{padding-left:1.2em}strong{font-weight:600}h1,h2,h3,h4,h5,h6{font-weight:600;line-height:1.25}.content:not(.custom)>h1,.content:not(.custom)>h2,.content:not(.custom)>h3,.content:not(.custom)>h4,.content:not(.custom)>h5,.content:not(.custom)>h6{margin-top:-3.1rem;padding-top:4.6rem;margin-bottom:0}.content:not(.custom)>h1:first-child,.content:not(.custom)>h2:first-child,.content:not(.custom)>h3:first-child,.content:not(.custom)>h4:first-child,.content:not(.custom)>h5:first-child,.content:not(.custom)>h6:first-child{margin-top:-1.5rem;margin-bottom:1rem}.content:not(.custom)>h1:first-child+.custom-block,.content:not(.custom)>h1:first-child+p,.content:not(.custom)>h1:first-child+pre,.content:not(.custom)>h2:first-child+.custom-block,.content:not(.custom)>h2:first-child+p,.content:not(.custom)>h2:first-child+pre,.content:not(.custom)>h3:first-child+.custom-block,.content:not(.custom)>h3:first-child+p,.content:not(.custom)>h3:first-child+pre,.content:not(.custom)>h4:first-child+.custom-block,.content:not(.custom)>h4:first-child+p,.content:not(.custom)>h4:first-child+pre,.content:not(.custom)>h5:first-child+.custom-block,.content:not(.custom)>h5:first-child+p,.content:not(.custom)>h5:first-child+pre,.content:not(.custom)>h6:first-child+.custom-block,.content:not(.custom)>h6:first-child+p,.content:not(.custom)>h6:first-child+pre{margin-top:2rem}h1:hover .header-anchor,h2:hover .header-anchor,h3:hover .header-anchor,h4:hover .header-anchor,h5:hover .header-anchor,h6:hover .header-anchor{opacity:1}h1{font-size:2.2rem}h2{font-size:1.65rem;padding-bottom:.3rem;border-bottom:1px solid #eaecef}h3{font-size:1.35rem}a.header-anchor{font-size:.85em;float:left;margin-left:-.87em;padding-right:.23em;margin-top:.125em;opacity:0}a.header-anchor:hover{text-decoration:none}.line-number,code,kbd{font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace}ol,p,ul{line-height:1.7}hr{border:0;border-top:1px solid #eaecef}table{border-collapse:collapse;margin:1rem 0;display:block;overflow-x:auto}tr{border-top:1px solid #dfe2e5}tr:nth-child(2n){background-color:#f6f8fa}td,th{border:1px solid #dfe2e5;padding:.6em 1em}.theme-container.sidebar-open .sidebar-mask{display:block}.theme-container.no-navbar .content:not(.custom)>h1,.theme-container.no-navbar h2,.theme-container.no-navbar h3,.theme-container.no-navbar h4,.theme-container.no-navbar h5,.theme-container.no-navbar h6{margin-top:1.5rem;padding-top:0}.theme-container.no-navbar .sidebar{top:0}@media (min-width:720px){.theme-container.no-sidebar .sidebar{display:none}.theme-container.no-sidebar .page{padding-left:0}}@media (max-width:959px){.sidebar{font-size:15px;width:16.4rem}.page{padding-left:16.4rem}}@media (max-width:719px){.sidebar{top:0;padding-top:3.6rem;-webkit-transform:translateX(-100%);transform:translateX(-100%);-webkit-transition:-webkit-transform .2s ease;transition:-webkit-transform .2s ease;transition:transform .2s ease;transition:transform .2s ease,-webkit-transform .2s ease}.page{padding-left:0}.theme-container.sidebar-open .sidebar{-webkit-transform:translateX(0);transform:translateX(0)}.theme-container.no-navbar .sidebar{padding-top:0}}@media (max-width:419px){h1{font-size:1.9rem}.content div[class*=language-]{margin:.85rem -1.5rem;border-radius:0}}.badge[data-v-efceadb8]{display:inline-block;font-size:14px;height:18px;line-height:18px;border-radius:3px;padding:0 6px;color:#fff;margin-right:5px;background-color:#42b983}.badge.middle[data-v-efceadb8]{vertical-align:middle}.badge.top[data-v-efceadb8]{vertical-align:top}.badge.green[data-v-efceadb8],.badge.tip[data-v-efceadb8]{background-color:#42b983}.badge.error[data-v-efceadb8]{background-color:#da5961}.badge.warn[data-v-efceadb8],.badge.warning[data-v-efceadb8],.badge.yellow[data-v-efceadb8]{background-color:#e7c000} \ No newline at end of file diff --git a/docs/assets/img/search.83621669.svg b/docs/assets/img/search.83621669.svg deleted file mode 100644 index 03d83913e8..0000000000 --- a/docs/assets/img/search.83621669.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/assets/js/10.730dd1f8.js b/docs/assets/js/10.730dd1f8.js deleted file mode 100644 index 3307fdafb9..0000000000 --- a/docs/assets/js/10.730dd1f8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{339:function(t,r,e){"use strict";e.r(r);var o=e(46),a=Object(o.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-javascript-api"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-javascript-api","aria-hidden":"true"}},[t._v("#")]),t._v(" Polkadot Javascript API")]),t._v(" "),e("p",[t._v("You can query a node and interact with the Polkadot network using Javascript. This guide describes the Polkadot Javascript API.")]),t._v(" "),e("h2",{attrs:{id:"the-polkadot-project"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#the-polkadot-project","aria-hidden":"true"}},[t._v("#")]),t._v(" The Polkadot Project")]),t._v(" "),e("p",[t._v("You can read more about the Polkadot Network at "),e("a",{attrs:{href:"https://polkadot.network/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://polkadot.network/"),e("OutboundLink")],1),t._v(" and more about the polkadot-js projects at "),e("a",{attrs:{href:"https://polkadot.js.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://polkadot.js.org"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"github-repositories"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#github-repositories","aria-hidden":"true"}},[t._v("#")]),t._v(" Github repositories")]),t._v(" "),e("p",[t._v("You can find the Polkadot repositories at:")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://github.com/polkadot-js",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/paritytech/polkadot",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/polkadot"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/paritytech/substrate",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/substrate"),e("OutboundLink")],1)])]),t._v(" "),e("p",[t._v("This documentation is generated from "),e("a",{attrs:{href:"https://github.com/polkadot-js/api",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/polkadot-js/api"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"contributing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[t._v("#")]),t._v(" Contributing")]),t._v(" "),e("p",[t._v("Contribution to the Polkadot JS API are more than welcome. You can "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("report issues"),e("OutboundLink")],1),t._v(" and "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/issues/new",target:"_blank",rel:"noopener noreferrer"}},[t._v("log feature requests"),e("OutboundLink")],1),t._v(".")])])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/100.ca511823.js b/docs/assets/js/100.ca511823.js deleted file mode 100644 index a41b97c2bf..0000000000 --- a/docs/assets/js/100.ca511823.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{456:function(t,e,r){"use strict";r.r(e);var s=r(46),i=Object(s.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/rpc-core/modules/_types_.html"}},[this._v('"types"')]),this._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/rpc-core/interfaces/_types_.rpcinterface.html"}},[this._v("RpcInterface")])],1),this._v(" "),e("li",[e("router-link",{attrs:{to:"/rpc-core/interfaces/_types_.rpcinterface_method.html"}},[this._v("RpcInterface$Method")])],1)])],1)])])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/101.553ffa55.js b/docs/assets/js/101.553ffa55.js deleted file mode 100644 index f0ad43cdd4..0000000000 --- a/docs/assets/js/101.553ffa55.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{457:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("RpcInterface")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"author"}})]),t._v(" "),r("h2",{attrs:{id:"author"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#author","aria-hidden":"true"}},[t._v("#")]),t._v(" author")]),t._v(" "),r("p",[r("strong",[t._v("● author")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/rpc-core/modules/_types_.html#rpcinterface_section"}},[t._v("RpcInterface$Section")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"chain"}})]),t._v(" "),r("h2",{attrs:{id:"chain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#chain","aria-hidden":"true"}},[t._v("#")]),t._v(" chain")]),t._v(" "),r("p",[r("strong",[t._v("● chain")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/rpc-core/modules/_types_.html#rpcinterface_section"}},[t._v("RpcInterface$Section")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"state"}})]),t._v(" "),r("h2",{attrs:{id:"state"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#state","aria-hidden":"true"}},[t._v("#")]),t._v(" state")]),t._v(" "),r("p",[r("strong",[t._v("● state")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/rpc-core/modules/_types_.html#rpcinterface_section"}},[t._v("RpcInterface$Section")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"system"}})]),t._v(" "),r("h2",{attrs:{id:"system"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#system","aria-hidden":"true"}},[t._v("#")]),t._v(" system")]),t._v(" "),r("p",[r("strong",[t._v("● system")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/rpc-core/modules/_types_.html#rpcinterface_section"}},[t._v("RpcInterface$Section")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/102.0da1ec79.js b/docs/assets/js/102.0da1ec79.js deleted file mode 100644 index a15d12ceaf..0000000000 --- a/docs/assets/js/102.0da1ec79.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{459:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("RpcInterface$Method")])]),e._v(" "),r("h1",{attrs:{id:"callable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#callable","aria-hidden":"true"}},[e._v("#")]),e._v(" Callable")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__call")]),e._v("(...params: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v("): "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" params")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"subscription"}})]),e._v(" "),r("h2",{attrs:{id:"subscription"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscription","aria-hidden":"true"}},[e._v("#")]),e._v(" subscription")]),e._v(" "),r("p",[r("strong",[e._v("● subscription")]),e._v(": "),r("em",[r("code",[e._v("string")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:8"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unsubscribe"}})]),e._v(" "),r("h2",{attrs:{id:"unsubscribe"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unsubscribe","aria-hidden":"true"}},[e._v("#")]),e._v(" unsubscribe")]),e._v(" "),r("p",[r("strong",[e._v("● unsubscribe")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:9"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(id: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("id")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/103.1f02833f.js b/docs/assets/js/103.1f02833f.js deleted file mode 100644 index d23464cb8d..0000000000 --- a/docs/assets/js/103.1f02833f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{460:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/rpc-core/interfaces/_types_.rpcinterface.html"}},[e._v("RpcInterface")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/rpc-core/interfaces/_types_.rpcinterface_method.html"}},[e._v("RpcInterface$Method")])],1)]),e._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/rpc-core/modules/_types_.html#rpcinterface_section"}},[e._v("RpcInterface$Section")])],1)]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"rpcinterface_section"}})]),e._v(" "),a("h2",{attrs:{id:"rpcinterface-section"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpcinterface-section","aria-hidden":"true"}},[e._v("#")]),e._v(" RpcInterface$Section")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ RpcInterface$Section")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:12"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/104.85ac0811.js b/docs/assets/js/104.85ac0811.js deleted file mode 100644 index ff0a950373..0000000000 --- a/docs/assets/js/104.85ac0811.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{462:function(s,t,a){"use strict";a.r(t);var n=a(46),e=Object(n.a)({},function(){var s=this,t=s.$createElement,a=s._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-rpc-provider"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-rpc-provider","aria-hidden":"true"}},[s._v("#")]),s._v(" @polkadot/rpc-provider")]),s._v(" "),a("p",[s._v("Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.")]),s._v(" "),a("h2",{attrs:{id:"provider-selection"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#provider-selection","aria-hidden":"true"}},[s._v("#")]),s._v(" Provider Selection")]),s._v(" "),a("p",[s._v("There are two flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets. It is generally recommended to use the "),a("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[s._v("WsProvider")]),s._v(" since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.")],1),s._v(" "),a("p",[s._v("Both providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection.")]),s._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[s._v("#")]),s._v(" Usage")]),s._v(" "),a("p",[s._v("Installation -")]),s._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[s._v("yarn add @polkadot/rpc-provider\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br")])]),a("p",[s._v("WebSocket Initialisation -")]),s._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" WsProvider "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/rpc-provider/ws'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// this is the actual default endpoint")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" provider "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("new")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[s._v("WsProvider")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'ws://127.0.0.1:9944'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" version "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("await")]),s._v(" provider"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("send")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'client_version'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'client version'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" version"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br"),a("span",{staticClass:"line-number"},[s._v("4")]),a("br"),a("span",{staticClass:"line-number"},[s._v("5")]),a("br"),a("span",{staticClass:"line-number"},[s._v("6")]),a("br"),a("span",{staticClass:"line-number"},[s._v("7")]),a("br")])]),a("p",[s._v("HTTP Initialisation -")]),s._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("import")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("{")]),s._v(" HttpProvider "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("}")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("from")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'@polkadot/rpc-provider'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("// this is the actual default endpoint")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" provider "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("new")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[s._v("HttpProvider")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'http://127.0.0.1:9933'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("const")]),s._v(" version "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[s._v("await")]),s._v(" provider"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("send")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'chain_getBlockHash'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n\nconsole"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'latest block Hash'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(",")]),s._v(" hash"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v(";")]),s._v("\n")])]),s._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[s._v("1")]),a("br"),a("span",{staticClass:"line-number"},[s._v("2")]),a("br"),a("span",{staticClass:"line-number"},[s._v("3")]),a("br"),a("span",{staticClass:"line-number"},[s._v("4")]),a("br"),a("span",{staticClass:"line-number"},[s._v("5")]),a("br"),a("span",{staticClass:"line-number"},[s._v("6")]),a("br"),a("span",{staticClass:"line-number"},[s._v("7")]),a("br")])]),a("h2",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[s._v("#")]),s._v(" Classes")]),s._v(" "),a("p",[a("router-link",{attrs:{to:"/rpc-provider/SUMMARY.html"}},[s._v("Classes")])],1)])},[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/105.7e80c03b.js b/docs/assets/js/105.7e80c03b.js deleted file mode 100644 index 63e1bdc8dd..0000000000 --- a/docs/assets/js/105.7e80c03b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{463:function(t,r,e){"use strict";e.r(r);var l=e(46),o=Object(l.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/rpc-provider/modules/_defaults_.html"}},[t._v('"defaults"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/rpc-provider/modules/_http_polyfill_.html"}},[t._v('"http/polyfill"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/rpc-provider/modules/_http_types_.html"}},[t._v('"http/types"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/rpc-provider/modules/_mock_types_.html"}},[t._v('"mock/types"')])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/rpc-provider/interfaces/_types_.providerinterface.html"}},[t._v("ProviderInterface")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/rpc-provider/modules/_ws_provider_.html"}},[t._v('"ws/Provider"')]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[t._v("WsProvider")])],1)])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/rpc-provider/modules/_ws_polyfill_.html"}},[t._v('"ws/polyfill"')])],1)])])},[],!1,null,null,null);r.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/106.5e6f31b1.js b/docs/assets/js/106.5e6f31b1.js deleted file mode 100644 index 5329ed7bbd..0000000000 --- a/docs/assets/js/106.5e6f31b1.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{465:function(t,r,e){"use strict";e.r(r);var s=e(46),a=Object(s.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-rpc-provider-ws"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-rpc-provider-ws","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/rpc-provider/ws")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": WsProvider")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. Unlike the [[HttpProvider]], it does support subscriptions and allows listening to events such as new blocks or balance changes.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" WsProvider "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/rpc-provider/ws'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ws://127.0.0.1:9944'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Api")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br")])]),e("p",[e("em",[e("strong",[t._v("see")])]),t._v(": [[HttpProvider]]")]),t._v(" "),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("WsProvider")])]),t._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("WSProviderInterface")])])]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new WsProvider")]),t._v("(endpoint?: "),e("em",[e("code",[t._v("string")])]),t._v(", autoConnect?: "),e("em",[e("code",[t._v("boolean")])]),t._v("): "),e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[t._v("WsProvider")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:75"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" endpoint")]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("defaults.WS_URL")]),t._v(" "),e("td",[t._v("The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" autoConnect")]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Whether to connect automatically or not.")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[t._v("WsProvider")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"accessors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),e("p",[e("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),e("h2",{attrs:{id:"hassubscriptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),e("p",[e("strong",[t._v("get hasSubscriptions")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:101"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": "),e("code",[t._v("true")]),t._v(" when this provider supports subscriptions")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("boolean")])]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("p",[e("a",{attrs:{id:"clone"}})]),t._v(" "),e("h2",{attrs:{id:"clone"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[t._v("#")]),t._v(" clone")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("clone")]),t._v("(): "),e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[t._v("WsProvider")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L108",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:108"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Returns a clone of the object")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[t._v("WsProvider")])],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"connect"}})]),t._v(" "),e("h2",{attrs:{id:"connect"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#connect","aria-hidden":"true"}},[t._v("#")]),t._v(" connect")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("connect")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L117",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:117"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Manually connect")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The "),e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[t._v("WsProvider")]),t._v(" connects automatically by default, however if you decided otherwise, you may connect manually using this method.")],1),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"disconnect"}})]),t._v(" "),e("h2",{attrs:{id:"disconnect"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("disconnect")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L133",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:133"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Manually disconnect from the connection, clearing autoconnect logic")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"isconnected"}})]),t._v(" "),e("h2",{attrs:{id:"isconnected"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isconnected","aria-hidden":"true"}},[t._v("#")]),t._v(" isConnected")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isConnected")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L150",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:150"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Whether the node is connected or not.")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("boolean")]),t._v("\ntrue if connected")]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"on"}})]),t._v(" "),e("h2",{attrs:{id:"on"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("on")]),t._v("(type: "),e("em",[e("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitted"}},[t._v("ProviderInterface$Emitted")])],1),t._v(", sub: "),e("em",[e("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitcb"}},[t._v("ProviderInterface$EmitCb")])],1),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L159",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:159"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Listens on events after having subscribed using the "),e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html#subscribe"}},[t._v("subscribe")]),t._v(" function.")],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitted"}},[t._v("ProviderInterface$Emitted")])],1),t._v(" "),e("td",[t._v("Event")])]),t._v(" "),e("tr",[e("td",[t._v("sub")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitcb"}},[t._v("ProviderInterface$EmitCb")])],1),t._v(" "),e("td",[t._v("Callback")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"send"}})]),t._v(" "),e("h2",{attrs:{id:"send"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#send","aria-hidden":"true"}},[t._v("#")]),t._v(" send")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("send")]),t._v("(method: "),e("em",[e("code",[t._v("string")])]),t._v(", params: "),e("em",[e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("any")]),t._v(">")]),t._v(", subscription?: "),e("em",[e("code",[t._v("SubscriptionHandler")])]),t._v("): "),e("code",[t._v("Promise")]),t._v("<"),e("code",[t._v("any")]),t._v(">")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L169",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:169"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Send JSON data using WebSockets to configured HTTP Endpoint or queue.")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("method")]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("The RPC methods to execute")])]),t._v(" "),e("tr",[e("td",[t._v("params")]),t._v(" "),e("td",[e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("any")]),t._v(">")]),t._v(" "),e("td",[t._v("Encoded paramaters as appliucable for the method")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" subscription")]),t._v(" "),e("td",[e("code",[t._v("SubscriptionHandler")])]),t._v(" "),e("td",[t._v("Subscription details (internally used)")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Promise")]),t._v("<"),e("code",[t._v("any")]),t._v(">")]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"subscribe"}})]),t._v(" "),e("h2",{attrs:{id:"subscribe"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#subscribe","aria-hidden":"true"}},[t._v("#")]),t._v(" subscribe")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("subscribe")]),t._v("(type: "),e("em",[e("code",[t._v("string")])]),t._v(", method: "),e("em",[e("code",[t._v("string")])]),t._v(", params: "),e("em",[e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("any")]),t._v(">")]),t._v(", callback: "),e("em",[e("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_callback"}},[t._v("ProviderInterface$Callback")])],1),t._v("): "),e("code",[t._v("Promise")]),t._v("<"),e("code",[t._v("number")]),t._v(">")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L223",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:223"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("name")])]),t._v(": subscribe")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Allows subscribing to a specific event.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ws://127.0.0.1:9944'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" rpc "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Rpc")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nrpc"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("state"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeStorage")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("storage"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("freeBalance"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("Address"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" values"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("values"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("subscriptionId"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'balance changes subscription id: '")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" subscriptionId"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br"),e("span",{staticClass:"line-number"},[t._v("8")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("Subscription type")])]),t._v(" "),e("tr",[e("td",[t._v("method")]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("Subscription method")])]),t._v(" "),e("tr",[e("td",[t._v("params")]),t._v(" "),e("td",[e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("any")]),t._v(">")]),t._v(" "),e("td",[t._v("Parameters")])]),t._v(" "),e("tr",[e("td",[t._v("callback")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_callback"}},[t._v("ProviderInterface$Callback")])],1),t._v(" "),e("td",[t._v("Callback")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Promise")]),t._v("<"),e("code",[t._v("number")]),t._v(">\nPromise resolving to the dd of the subscription you can use with [[unsubscribe]].")]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"unsubscribe"}})]),t._v(" "),e("h2",{attrs:{id:"unsubscribe"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unsubscribe","aria-hidden":"true"}},[t._v("#")]),t._v(" unsubscribe")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("unsubscribe")]),t._v("(type: "),e("em",[e("code",[t._v("string")])]),t._v(", method: "),e("em",[e("code",[t._v("string")])]),t._v(", id: "),e("em",[e("code",[t._v("number")])]),t._v("): "),e("code",[t._v("Promise")]),t._v("<"),e("code",[t._v("boolean")]),t._v(">")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L232",target:"_blank",rel:"noopener noreferrer"}},[t._v("ws/Provider.ts:232"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("summary")])]),t._v(": Allows unsubscribing to subscriptions made with "),e("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html#subscribe"}},[t._v("subscribe")]),t._v(".")],1),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",[t._v("method")]),t._v(" "),e("td",[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",[t._v("id")]),t._v(" "),e("td",[e("code",[t._v("number")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Promise")]),t._v("<"),e("code",[t._v("boolean")]),t._v(">")]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/107.5f08e115.js b/docs/assets/js/107.5f08e115.js deleted file mode 100644 index 6923788c07..0000000000 --- a/docs/assets/js/107.5f08e115.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{466:function(e,t,r){"use strict";r.r(t);var v=r(46),_=Object(v.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("ProviderInterface")])]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"hassubscriptions"}})]),e._v(" "),r("h2",{attrs:{id:"hassubscriptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[e._v("#")]),e._v(" hasSubscriptions")]),e._v(" "),r("p",[r("strong",[e._v("● hasSubscriptions")]),e._v(": "),r("em",[r("code",[e._v("boolean")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:45"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"clone"}})]),e._v(" "),r("h2",{attrs:{id:"clone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("clone")]),e._v("(): "),r("router-link",{attrs:{to:"/rpc-provider/interfaces/_types_.providerinterface.html"}},[e._v("ProviderInterface")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/rpc-provider/interfaces/_types_.providerinterface.html"}},[e._v("ProviderInterface")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"disconnect"}})]),e._v(" "),r("h2",{attrs:{id:"disconnect"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[e._v("#")]),e._v(" disconnect")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("disconnect")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:47"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isconnected"}})]),e._v(" "),r("h2",{attrs:{id:"isconnected"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isconnected","aria-hidden":"true"}},[e._v("#")]),e._v(" isConnected")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("isConnected")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"on"}})]),e._v(" "),r("h2",{attrs:{id:"on"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[e._v("#")]),e._v(" on")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("on")]),e._v("(type: "),r("em",[r("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitted"}},[e._v("ProviderInterface$Emitted")])],1),e._v(", sub: "),r("em",[r("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitcb"}},[e._v("ProviderInterface$EmitCb")])],1),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:49"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitted"}},[e._v("ProviderInterface$Emitted")])],1)]),e._v(" "),r("tr",[r("td",[e._v("sub")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitcb"}},[e._v("ProviderInterface$EmitCb")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"send"}})]),e._v(" "),r("h2",{attrs:{id:"send"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#send","aria-hidden":"true"}},[e._v("#")]),e._v(" send")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("send")]),e._v("(method: "),r("em",[r("code",[e._v("string")])]),e._v(", params: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v("): "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("method")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("params")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subscribe"}})]),e._v(" "),r("h2",{attrs:{id:"subscribe"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscribe","aria-hidden":"true"}},[e._v("#")]),e._v(" subscribe")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subscribe")]),e._v("(type: "),r("em",[r("code",[e._v("string")])]),e._v(", method: "),r("em",[r("code",[e._v("string")])]),e._v(", params: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(", cb: "),r("em",[r("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_callback"}},[e._v("ProviderInterface$Callback")])],1),e._v("): "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:51"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("type")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("method")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("params")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")])]),e._v(" "),r("tr",[r("td",[e._v("cb")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_callback"}},[e._v("ProviderInterface$Callback")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unsubscribe"}})]),e._v(" "),r("h2",{attrs:{id:"unsubscribe"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unsubscribe","aria-hidden":"true"}},[e._v("#")]),e._v(" unsubscribe")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unsubscribe")]),e._v("(type: "),r("em",[r("code",[e._v("string")])]),e._v(", method: "),r("em",[r("code",[e._v("string")])]),e._v(", id: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("boolean")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("type")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("method")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("id")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Promise")]),e._v("<"),r("code",[e._v("boolean")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/108.643f37cd.js b/docs/assets/js/108.643f37cd.js deleted file mode 100644 index e446fb634f..0000000000 --- a/docs/assets/js/108.643f37cd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{468:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/109.2bfc3f88.js b/docs/assets/js/109.2bfc3f88.js deleted file mode 100644 index a5fbf82d30..0000000000 --- a/docs/assets/js/109.2bfc3f88.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{469:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/11.16564673.js b/docs/assets/js/11.16564673.js deleted file mode 100644 index fe33406002..0000000000 --- a/docs/assets/js/11.16564673.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{718:function(t,e,s){"use strict";s.r(e);var _=s(46),i=Object(_.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h2",{attrs:{id:"packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#packages","aria-hidden":"true"}},[t._v("#")]),t._v(" Packages")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/api/"}},[t._v("api")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/api/classes/_promise_index_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/api/classes/_rx_index_.apirx.html"}},[t._v("ApiRx")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/rpc-provider/"}},[t._v("rpc-provider")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/rpc-provider/classes/_http_index_.httpprovider.html"}},[t._v("HttpProvider")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/rpc-provider/classes/_ws_index_.wsprovider.html"}},[t._v("WsProvider")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/"}},[t._v("types (codec implementation)")])],1)]),t._v(" "),s("h2",{attrs:{id:"interfaces"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/METHODS_RPC.html"}},[t._v("RPC")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/METHODS_STORAGE.html"}},[t._v("Chain state (runtime)")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/METHODS_EXTRINSICS.html"}},[t._v("Extrinsics (runtime)")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/METHODS_EVENTS.html"}},[t._v("Events (runtime)")])],1)]),t._v(" "),s("h2",{attrs:{id:"examples"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#examples","aria-hidden":"true"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/examples/promise/"}},[t._v("ApiPromise")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/examples/promise/01_simple_connect/"}},[t._v("Simple connect")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/02_listen_to_blocks/"}},[t._v("Listen to blocks")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/03_listen_to_balance_change/"}},[t._v("Listen to balance change")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/04_unsubscribe/"}},[t._v("Unsubscribe from listening")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/05_read_storage/"}},[t._v("Read chain state")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/06_make_transfer/"}},[t._v("Make a transfer")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/08_system_events/"}},[t._v("Display system events")]),t._v("(")],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/09_transfer_events/"}},[t._v("Transaction with events")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/promise/10_upgrade_chain/"}},[t._v("Upgrade via sudo")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/"}},[t._v("ApiRx")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/examples/rx/01_simple_connect/"}},[t._v("Simple connect")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/02_listen_to_blocks/"}},[t._v("Listen to blocks")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/03_listen_to_balance_change/"}},[t._v("Listen to balance change")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/04_unsubscribe/"}},[t._v("Unsubscribe from listening")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/05_read_storage/"}},[t._v("Read chain state")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/06_make_transfer/"}},[t._v("Make a transfer")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/08_system_events/"}},[t._v("Display system events")]),t._v("(")],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/09_transfer_events/"}},[t._v("Transaction with events")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/examples/rx/10_upgrade_chain/"}},[t._v("Upgrade via sudo")])],1)])],1)]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_typeregistry_.typeregistry.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("hidden")])],1)]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.methodindex.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("hidden")])],1)]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[t._v("hidden")])],1)]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_index_.metadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_index_.metadatav0.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.,maptype.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype_map.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_index_.metadatamodule.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_index_.metadatav1.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.default.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.optional.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[t._v("hidden")])],1)]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountidof.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.availabilityvote.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.balanceupload.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.egressqueueroot.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.headdata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityattestation.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityvote.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_chainproperties_.chainproperties.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.broadcast.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.dropped.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.extrinsicstatus.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.finalised.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.future.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.invalid.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.ready.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicstatus_.usurped.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_health_.health.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_lockperiods_.lockperiods.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_noncecompact_.noncecompact.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_peerinfo_.peerinfo.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_pendingextrinsics_.pendingextrinsics.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_runtimeversion_.apiid.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_runtimeversion_.runtimeversion.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_runtimeversion_.runtimeversionapi.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.ed25519signature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.sr25519signature.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signedblock_.signedblock.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_storagechangeset_.storagechangeset.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[t._v("hidden")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[t._v("hidden")])],1)])])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/110.391cd976.js b/docs/assets/js/110.391cd976.js deleted file mode 100644 index 7e818c4b53..0000000000 --- a/docs/assets/js/110.391cd976.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{471:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"httpstate"}})]),t._v(" "),a("h2",{attrs:{id:"httpstate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#httpstate","aria-hidden":"true"}},[t._v("#")]),t._v(" HttpState")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ HttpState")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/http/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("http/types.ts:9"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/111.247898ab.js b/docs/assets/js/111.247898ab.js deleted file mode 100644 index 0f9ac039cb..0000000000 --- a/docs/assets/js/111.247898ab.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{472:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"mockstate_db"}})]),t._v(" "),a("h2",{attrs:{id:"mockstate-db"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mockstate-db","aria-hidden":"true"}},[t._v("#")]),t._v(" MockState$Db")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ MockState$Db")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("mock/types.ts:16"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"mockstate_requests"}})]),t._v(" "),a("h2",{attrs:{id:"mockstate-requests"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mockstate-requests","aria-hidden":"true"}},[t._v("#")]),t._v(" MockState$Requests")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ MockState$Requests")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("mock/types.ts:20"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(db: "),a("em",[a("router-link",{attrs:{to:"/rpc-provider/modules/_mock_types_.html#mockstate_db"}},[t._v("MockState$Db")])],1),t._v(", params: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("db")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/rpc-provider/modules/_mock_types_.html#mockstate_db"}},[t._v("MockState$Db")])],1)]),t._v(" "),a("tr",[a("td",[t._v("params")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"mockstate_subscription_callback"}})]),t._v(" "),a("h2",{attrs:{id:"mockstate-subscription-callback"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mockstate-subscription-callback","aria-hidden":"true"}},[t._v("#")]),t._v(" MockState$Subscription$Callback")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ MockState$Subscription$Callback")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("mock/types.ts:5"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(error: "),a("em",[a("code",[t._v("Error")]),t._v(" | "),a("code",[t._v("null")])]),t._v(", value: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("error")]),t._v(" "),a("td",[a("code",[t._v("Error")]),t._v(" | "),a("code",[t._v("null")])])]),t._v(" "),a("tr",[a("td",[t._v("value")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"mockstate_subscriptions"}})]),t._v(" "),a("h2",{attrs:{id:"mockstate-subscriptions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#mockstate-subscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" MockState$Subscriptions")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ MockState$Subscriptions")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("mock/types.ts:7"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/112.1979bc80.js b/docs/assets/js/112.1979bc80.js deleted file mode 100644 index a3cc17b9dc..0000000000 --- a/docs/assets/js/112.1979bc80.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{474:function(e,r,t){"use strict";t.r(r);var a=t(46),s=Object(a.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),t("h3",{attrs:{id:"interfaces"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/rpc-provider/interfaces/_types_.providerinterface.html"}},[e._v("ProviderInterface")])],1)]),e._v(" "),t("h3",{attrs:{id:"type-aliases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcobject"}},[e._v("JsonRpcObject")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcrequest"}},[e._v("JsonRpcRequest")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcresponse"}},[e._v("JsonRpcResponse")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcresponsebase"}},[e._v("JsonRpcResponseBase")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcresponsebase_error"}},[e._v("JsonRpcResponseBase$Error")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_callback"}},[e._v("ProviderInterface$Callback")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitcb"}},[e._v("ProviderInterface$EmitCb")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#providerinterface_emitted"}},[e._v("ProviderInterface$Emitted")])],1)]),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"type-aliases-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("p",[t("a",{attrs:{id:"jsonrpcobject"}})]),e._v(" "),t("h2",{attrs:{id:"jsonrpcobject"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#jsonrpcobject","aria-hidden":"true"}},[e._v("#")]),e._v(" JsonRpcObject")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ JsonRpcObject")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:5"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"jsonrpcrequest"}})]),e._v(" "),t("h2",{attrs:{id:"jsonrpcrequest"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#jsonrpcrequest","aria-hidden":"true"}},[e._v("#")]),e._v(" JsonRpcRequest")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ JsonRpcRequest")]),e._v(": "),t("em",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcobject"}},[e._v("JsonRpcObject")]),e._v(" & "),t("code",[e._v("object")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:10"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"jsonrpcresponse"}})]),e._v(" "),t("h2",{attrs:{id:"jsonrpcresponse"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#jsonrpcresponse","aria-hidden":"true"}},[e._v("#")]),e._v(" JsonRpcResponse")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ JsonRpcResponse")]),e._v(": "),t("em",[t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcobject"}},[e._v("JsonRpcObject")]),e._v(" & "),t("router-link",{attrs:{to:"/rpc-provider/modules/_types_.html#jsonrpcresponsebase"}},[e._v("JsonRpcResponseBase")])],1)]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:36"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"jsonrpcresponsebase"}})]),e._v(" "),t("h2",{attrs:{id:"jsonrpcresponsebase"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#jsonrpcresponsebase","aria-hidden":"true"}},[e._v("#")]),e._v(" JsonRpcResponseBase")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ JsonRpcResponseBase")]),e._v(": "),t("em",[t("code",[e._v("JsonRpcResponse$Single")]),e._v(" & "),t("code",[e._v("JsonRpcResponse$Subscription")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:34"),t("OutboundLink")],1)])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"jsonrpcresponsebase_error"}})]),e._v(" "),t("h2",{attrs:{id:"jsonrpcresponsebase-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#jsonrpcresponsebase-error","aria-hidden":"true"}},[e._v("#")]),e._v(" JsonRpcResponseBase$Error")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ JsonRpcResponseBase$Error")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:15"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"providerinterface_callback"}})]),e._v(" "),t("h2",{attrs:{id:"providerinterface-callback"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#providerinterface-callback","aria-hidden":"true"}},[e._v("#")]),e._v(" ProviderInterface$Callback")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ ProviderInterface$Callback")]),e._v(": "),t("em",[t("code",[e._v("function")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:38"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("p",[e._v("▸(result: "),t("em",[t("code",[e._v("any")])]),e._v("): "),t("code",[e._v("void")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("result")]),e._v(" "),t("td",[t("code",[e._v("any")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("void")])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"providerinterface_emitcb"}})]),e._v(" "),t("h2",{attrs:{id:"providerinterface-emitcb"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#providerinterface-emitcb","aria-hidden":"true"}},[e._v("#")]),e._v(" ProviderInterface$EmitCb")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ ProviderInterface$EmitCb")]),e._v(": "),t("em",[t("code",[e._v("function")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:42"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("p",[e._v("▸(value?: "),t("em",[t("code",[e._v("any")])]),e._v("): "),t("code",[e._v("any")])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),t("td",[t("code",[e._v("any")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("any")])]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"providerinterface_emitted"}})]),e._v(" "),t("h2",{attrs:{id:"providerinterface-emitted"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#providerinterface-emitted","aria-hidden":"true"}},[e._v("#")]),e._v(" ProviderInterface$Emitted")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ ProviderInterface$Emitted")]),e._v(": "),t("em",[e._v('"connected" | "disconnected" | "error"')])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:40"),t("OutboundLink")],1)])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/113.4097126a.js b/docs/assets/js/113.4097126a.js deleted file mode 100644 index 5c9fa59139..0000000000 --- a/docs/assets/js/113.4097126a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{475:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/114.7c298e55.js b/docs/assets/js/114.7c298e55.js deleted file mode 100644 index 2706cfbade..0000000000 --- a/docs/assets/js/114.7c298e55.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{477:function(t,r,s){"use strict";s.r(r);var e=s(46),a=Object(e.a)({},function(){var t=this,r=t.$createElement,s=t._self._c||r;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/rpc-provider/classes/_ws_provider_.wsprovider.html"}},[t._v("WsProvider")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/115.0568f994.js b/docs/assets/js/115.0568f994.js deleted file mode 100644 index 2675f21ab2..0000000000 --- a/docs/assets/js/115.0568f994.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{478:function(t,r,a){"use strict";a.r(r);var s=a(46),e=Object(s.a)({},function(){var t=this,r=t.$createElement,a=t._self._c||r;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-rpc-rx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-rpc-rx","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/rpc-rx")]),t._v(" "),a("p",[t._v("An RxJs wrapper around the "),a("a",{attrs:{href:"../rpc-core"}},[t._v("@polkadot/rpc-core")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/rpc-rx/SUMMARY.html"}},[t._v("Classes")])],1)])},[],!1,null,null,null);r.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/116.7c28a393.js b/docs/assets/js/116.7c28a393.js deleted file mode 100644 index a3b3bdd47c..0000000000 --- a/docs/assets/js/116.7c28a393.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[116],{480:function(t,e,s){"use strict";s.r(e);var l=s(46),n=Object(l.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/rpc-rx/modules/_types_.html"}},[this._v('"types"')])],1)])])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/117.bf1a2cc6.js b/docs/assets/js/117.bf1a2cc6.js deleted file mode 100644 index 7fb3746698..0000000000 --- a/docs/assets/js/117.bf1a2cc6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[117],{481:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),r("p",[r("a",{attrs:{id:"rpcrxinterface"}})]),e._v(" "),r("h2",{attrs:{id:"rpcrxinterface"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rpcrxinterface","aria-hidden":"true"}},[e._v("#")]),e._v(" RpcRxInterface")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ RpcRxInterface")]),e._v(": "),r("em",[r("code",[e._v("object")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"rpcrxinterface_events"}})]),e._v(" "),r("h2",{attrs:{id:"rpcrxinterface-events"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rpcrxinterface-events","aria-hidden":"true"}},[e._v("#")]),e._v(" RpcRxInterface$Events")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ RpcRxInterface$Events")]),e._v(": "),r("em",[r("code",[e._v("ProviderInterface$Emitted")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"rpcrxinterface_method"}})]),e._v(" "),r("h2",{attrs:{id:"rpcrxinterface-method"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rpcrxinterface-method","aria-hidden":"true"}},[e._v("#")]),e._v(" RpcRxInterface$Method")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ RpcRxInterface$Method")]),e._v(": "),r("em",[r("code",[e._v("function")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:8"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("p",[e._v("▸(...params: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v("): "),r("code",[e._v("Observable")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" params")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Observable")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"rpcrxinterface_section"}})]),e._v(" "),r("h2",{attrs:{id:"rpcrxinterface-section"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rpcrxinterface-section","aria-hidden":"true"}},[e._v("#")]),e._v(" RpcRxInterface$Section")]),e._v(" "),r("p",[r("strong",[e._v("Ƭ RpcRxInterface$Section")]),e._v(": "),r("em",[r("code",[e._v("object")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:10"),r("OutboundLink")],1)])]),e._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/118.b1c65641.js b/docs/assets/js/118.b1c65641.js deleted file mode 100644 index 150868038c..0000000000 --- a/docs/assets/js/118.b1c65641.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{561:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-extrinsics"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-extrinsics","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/extrinsics")]),t._v(" "),e("p",[t._v("Base extrinsic definitions & codecs")]),t._v(" "),e("h2",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/type-extrinsics/SUMMARY.html"}},[t._v("Classes")])],1)])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/119.21ea0a94.js b/docs/assets/js/119.21ea0a94.js deleted file mode 100644 index d5dbe97400..0000000000 --- a/docs/assets/js/119.21ea0a94.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{487:function(t,e,s){"use strict";s.r(e);var i=s(46),r=Object(i.a)({},function(){var t=this.$createElement,e=this._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[e("ul",[e("li",[e("router-link",{attrs:{to:"/type-extrinsics/modules/_frommetadata_.html"}},[this._v('"fromMetadata"')])],1),this._v(" "),e("li",[e("router-link",{attrs:{to:"/type-extrinsics/modules/_static_.html"}},[this._v('"static"')])],1),this._v(" "),e("li",[e("router-link",{attrs:{to:"/type-extrinsics/modules/_utils_createunchecked_.html"}},[this._v('"utils/createUnchecked"')])],1)])])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/12.23b26fea.js b/docs/assets/js/12.23b26fea.js deleted file mode 100644 index 1f4ecf7a58..0000000000 --- a/docs/assets/js/12.23b26fea.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{340:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-api-derive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-api-derive","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/api-derive")]),t._v(" "),a("p",[t._v("Common functions used across Polkadot, derived from RPC calls and storage queries.")]),t._v(" "),a("h2",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/api-derive/SUMMARY.html"}},[t._v("Classes")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/120.32f79155.js b/docs/assets/js/120.32f79155.js deleted file mode 100644 index 69e29234a5..0000000000 --- a/docs/assets/js/120.32f79155.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{489:function(t,a,e){"use strict";e.r(a);var r=e(46),o=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"frommetadata"}})]),t._v(" "),e("h2",{attrs:{id:"frommetadata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#frommetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" fromMetadata")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fromMetadata")]),t._v("(metadata: "),e("em",[e("code",[t._v("MetadataV0")])]),t._v("): "),e("code",[t._v("ModulesWithMethods")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-extrinsics/src/fromMetadata.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("fromMetadata.ts:21"),e("OutboundLink")],1)])]),t._v(" "),e("p",[t._v("Extend a storage object with the storage modules & module functions present in the metadata.")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("metadata")]),t._v(" "),e("td",[e("code",[t._v("MetadataV0")])]),t._v(" "),e("td",[t._v("The metadata to extend the storage object against.")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("ModulesWithMethods")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/121.84147bfd.js b/docs/assets/js/121.84147bfd.js deleted file mode 100644 index 12a01df7d4..0000000000 --- a/docs/assets/js/121.84147bfd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[121],{490:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/122.9d807a94.js b/docs/assets/js/122.9d807a94.js deleted file mode 100644 index 4a6cf5884e..0000000000 --- a/docs/assets/js/122.9d807a94.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{492:function(t,e,r){"use strict";r.r(e);var n=r(46),a=Object(n.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createdescriptor"}})]),t._v(" "),r("h2",{attrs:{id:"createdescriptor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createdescriptor","aria-hidden":"true"}},[t._v("#")]),t._v(" createDescriptor")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createDescriptor")]),t._v("(section: "),r("em",[r("code",[t._v("string")])]),t._v(", method: "),r("em",[r("code",[t._v("string")])]),t._v(", index: "),r("em",[r("code",[t._v("number")])]),t._v(", meta: "),r("em",[r("code",[t._v("FunctionMetadata")])]),t._v("): "),r("code",[t._v("MethodFunction")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-extrinsics/src/utils/createUnchecked.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("utils/createUnchecked.ts:16"),r("OutboundLink")],1)])]),t._v(" "),r("p",[t._v("From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("section")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td")]),t._v(" "),r("tr",[r("td",[t._v("method")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td")]),t._v(" "),r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("Index of the module section in the modules array.")])]),t._v(" "),r("tr",[r("td",[t._v("meta")]),t._v(" "),r("td",[r("code",[t._v("FunctionMetadata")])]),t._v(" "),r("td")])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("MethodFunction")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/123.2a822b35.js b/docs/assets/js/123.2a822b35.js deleted file mode 100644 index 8f9abc11c6..0000000000 --- a/docs/assets/js/123.2a822b35.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{493:function(e,t,a){"use strict";a.r(t);var s=a(46),r=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-jsonrpc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-jsonrpc","aria-hidden":"true"}},[e._v("#")]),e._v(" @polkadot/jsonrpc")]),e._v(" "),a("p",[e._v("A definition of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking.")]),e._v(" "),a("p",[e._v("For a list of currently exposed methods, see the "),a("router-link",{attrs:{to:"/type-jsonrpc/docs/METHODS_RPC.html"}},[e._v("method documentation")]),e._v(".")],1),e._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[e._v("#")]),e._v(" Usage")]),e._v(" "),a("p",[e._v("Installation -")]),e._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("yarn add @polkadot/jsonrpc\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br")])]),a("h2",{attrs:{id:"adding-methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#adding-methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Adding methods")]),e._v(" "),a("p",[e._v("As methods are added, simply adding the name, inputs & output will prepare it for use.")]),e._v(" "),a("ul",[a("li",[e._v("Add the method to the correct file in "),a("router-link",{attrs:{to:"/type-jsonrpc/src/rpc/"}},[e._v("src/rpc/")]),e._v(" (Input/Output types as cross-referenced from the canonical implementation and match one-to-one)")],1),e._v(" "),a("li",[e._v("Should a new type be required, add it to the type list, "),a("a",{attrs:{href:"src/types.js"}},[e._v("src/types.js")]),e._v(" (Required for TSLint type checking)")])]),e._v(" "),a("h2",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),a("p",[a("router-link",{attrs:{to:"/type-jsonrpc/SUMMARY.html"}},[e._v("Classes")])],1)])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/124.4e7f4672.js b/docs/assets/js/124.4e7f4672.js deleted file mode 100644 index d4f30157ee..0000000000 --- a/docs/assets/js/124.4e7f4672.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[124],{495:function(t,e,r){"use strict";r.r(e);var o=r(46),s=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/type-jsonrpc/modules/_author_.html"}},[t._v('"author"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-jsonrpc/modules/_chain_.html"}},[t._v('"chain"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-jsonrpc/modules/_create_method_.html"}},[t._v('"create/method"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-jsonrpc/modules/_create_param_.html"}},[t._v('"create/param"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-jsonrpc/modules/_state_.html"}},[t._v('"state"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-jsonrpc/modules/_system_.html"}},[t._v('"system"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-jsonrpc/modules/_types_.html"}},[t._v('"types"')])],1)])])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/125.2e967439.js b/docs/assets/js/125.2e967439.js deleted file mode 100644 index be6f80a124..0000000000 --- a/docs/assets/js/125.2e967439.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[125],{496:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/126.2f75633a.js b/docs/assets/js/126.2f75633a.js deleted file mode 100644 index 71f7830dee..0000000000 --- a/docs/assets/js/126.2f75633a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[126],{498:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/127.6a1e1746.js b/docs/assets/js/127.6a1e1746.js deleted file mode 100644 index aac87d9403..0000000000 --- a/docs/assets/js/127.6a1e1746.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{499:function(t,e,r){"use strict";r.r(e);var o=r(46),a=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createmethod"}})]),t._v(" "),r("h2",{attrs:{id:"createmethod"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createmethod","aria-hidden":"true"}},[t._v("#")]),t._v(" createMethod")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createMethod")]),t._v("(section: "),r("em",[r("code",[t._v("string")])]),t._v(", method: "),r("em",[r("code",[t._v("string")])]),t._v(", __namedParameters: "),r("em",[r("code",[t._v("object")])]),t._v("): "),r("router-link",{attrs:{to:"/type-jsonrpc/modules/_types_.html#rpcmethod"}},[t._v("RpcMethod")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/create/method.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("create/method.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("section")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("method")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("__namedParameters")]),t._v(" "),r("td",[r("code",[t._v("object")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/type-jsonrpc/modules/_types_.html#rpcmethod"}},[t._v("RpcMethod")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/128.7cff7178.js b/docs/assets/js/128.7cff7178.js deleted file mode 100644 index 4d5fe664b8..0000000000 --- a/docs/assets/js/128.7cff7178.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[128],{501:function(t,e,a){"use strict";a.r(e);var r=a(46),_=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"createparam"}})]),t._v(" "),a("h2",{attrs:{id:"createparam"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#createparam","aria-hidden":"true"}},[t._v("#")]),t._v(" createParam")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("createParam")]),t._v("(name: "),a("em",[a("code",[t._v("string")])]),t._v(", type: "),a("em",[a("code",[t._v("CodecTypes")])]),t._v(", __namedParameters?: "),a("em",[a("code",[t._v("object")])]),t._v("): "),a("router-link",{attrs:{to:"/type-jsonrpc/modules/_types_.html#rpcparam"}},[t._v("RpcParam")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/create/param.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("create/param.ts:12"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("name")]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("code",[t._v("CodecTypes")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" __namedParameters")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[t._v("{ isOptional: false }")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/type-jsonrpc/modules/_types_.html#rpcparam"}},[t._v("RpcParam")])],1),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/129.ea33f5cb.js b/docs/assets/js/129.ea33f5cb.js deleted file mode 100644 index 03ca3f434a..0000000000 --- a/docs/assets/js/129.ea33f5cb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{502:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/13.89e4dbaf.js b/docs/assets/js/13.89e4dbaf.js deleted file mode 100644 index f1e84facee..0000000000 --- a/docs/assets/js/13.89e4dbaf.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{342:function(e,t,r){"use strict";r.r(t);var i=r(46),a=Object(i.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_accounts_idandindex_.html"}},[e._v('"accounts/idAndIndex"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_accounts_idtoindex_.html"}},[e._v('"accounts/idToIndex"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_accounts_indextoid_.html"}},[e._v('"accounts/indexToId"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_accounts_indexes_.html"}},[e._v('"accounts/indexes"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_balances_fees_.html"}},[e._v('"balances/fees"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_balances_validatingbalance_.html"}},[e._v('"balances/validatingBalance"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_balances_validatingbalances_.html"}},[e._v('"balances/validatingBalances"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_balances_votingbalance_.html"}},[e._v('"balances/votingBalance"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_balances_votingbalances_.html"}},[e._v('"balances/votingBalances"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_balances_votingbalancesnominatorsfor_.html"}},[e._v('"balances/votingBalancesNominatorsFor"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_chain_bestnumber_.html"}},[e._v('"chain/bestNumber"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_chain_bestnumberfinalised_.html"}},[e._v('"chain/bestNumberFinalised"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_chain_bestnumberlag_.html"}},[e._v('"chain/bestNumberLag"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_chain_getheader_.html"}},[e._v('"chain/getHeader"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_chain_subscribenewhead_.html"}},[e._v('"chain/subscribeNewHead"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_democracy_referenduminfo_.html"}},[e._v('"democracy/referendumInfo"')]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1)])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_democracy_referenduminfos_.html"}},[e._v('"democracy/referendumInfos"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_democracy_referendumvotesfor_.html"}},[e._v('"democracy/referendumVotesFor"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_democracy_referendums_.html"}},[e._v('"democracy/referendums"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_democracy_votes_.html"}},[e._v('"democracy/votes"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_session_eralength_.html"}},[e._v('"session/eraLength"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_session_eraprogress_.html"}},[e._v('"session/eraProgress"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_session_sessionprogress_.html"}},[e._v('"session/sessionProgress"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_staking_intentionsbalances_.html"}},[e._v('"staking/intentionsBalances"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_types_.html"}},[e._v('"types"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_util_cache_.html"}},[e._v('"util/cache"')])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/api-derive/modules/_util_drr_.html"}},[e._v('"util/drr"')])],1)])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/130.3c5e03a1.js b/docs/assets/js/130.3c5e03a1.js deleted file mode 100644 index 7c1eef3d47..0000000000 --- a/docs/assets/js/130.3c5e03a1.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{504:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/131.dcf81ac8.js b/docs/assets/js/131.dcf81ac8.js deleted file mode 100644 index 3cc8d70438..0000000000 --- a/docs/assets/js/131.dcf81ac8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{755:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"rpcmethod"}})]),t._v(" "),a("h2",{attrs:{id:"rpcmethod"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpcmethod","aria-hidden":"true"}},[t._v("#")]),t._v(" RpcMethod")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ RpcMethod")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:24"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpcmethodopt"}})]),t._v(" "),a("h2",{attrs:{id:"rpcmethodopt"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpcmethodopt","aria-hidden":"true"}},[t._v("#")]),t._v(" RpcMethodOpt")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ RpcMethodOpt")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:13"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpcparam"}})]),t._v(" "),a("h2",{attrs:{id:"rpcparam"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpcparam","aria-hidden":"true"}},[t._v("#")]),t._v(" RpcParam")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ RpcParam")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:7"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpcsection"}})]),t._v(" "),a("h2",{attrs:{id:"rpcsection"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpcsection","aria-hidden":"true"}},[t._v("#")]),t._v(" RpcSection")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ RpcSection")]),t._v(": "),a("em",[a("code",[t._v("object")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:38"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/132.cfdf6b8f.js b/docs/assets/js/132.cfdf6b8f.js deleted file mode 100644 index 87a2ff6b44..0000000000 --- a/docs/assets/js/132.cfdf6b8f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{506:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polkadot-storage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-storage","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/storage")]),t._v(" "),e("p",[t._v("An base interface to the storage layer")]),t._v(" "),e("h2",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/type-storage/SUMMARY.html"}},[t._v("Classes")])],1)])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/133.1a7accd7.js b/docs/assets/js/133.1a7accd7.js deleted file mode 100644 index 573cd7f799..0000000000 --- a/docs/assets/js/133.1a7accd7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[133],{507:function(t,e,r){"use strict";r.r(e);var o=r(46),s=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("ul",[r("li",[r("router-link",{attrs:{to:"/type-storage/modules/_frommetadata_.html"}},[t._v('"fromMetadata"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-storage/modules/_static_.html"}},[t._v('"static"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-storage/modules/_storage_.html"}},[t._v('"storage"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-storage/modules/_substrate_.html"}},[t._v('"substrate"')])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-storage/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/type-storage/interfaces/_types_.modulestorage.html"}},[t._v("ModuleStorage")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-storage/interfaces/_types_.storage.html"}},[t._v("Storage")])],1)])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-storage/modules/_utils_createfunction_.html"}},[t._v('"utils/createFunction"')]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/type-storage/interfaces/_utils_createfunction_.createitemoptions.html"}},[t._v("CreateItemOptions")])],1)])],1)])])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/134.402b574e.js b/docs/assets/js/134.402b574e.js deleted file mode 100644 index 0004bdd66d..0000000000 --- a/docs/assets/js/134.402b574e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{510:function(e,t,r){"use strict";r.r(t);var a=r(46),n=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("ModuleStorage")])]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[key: "),r("code",[e._v("string")]),e._v("]: "),r("code",[e._v("StorageFunction")])])])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/135.7dd6b4db.js b/docs/assets/js/135.7dd6b4db.js deleted file mode 100644 index 3308072aea..0000000000 --- a/docs/assets/js/135.7dd6b4db.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{509:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("Storage")])]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[key: "),r("code",[t._v("string")]),t._v("]: "),r("router-link",{attrs:{to:"/type-storage/interfaces/_types_.modulestorage.html"}},[t._v("ModuleStorage")])],1),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"substrate"}})]),t._v(" "),r("h2",{attrs:{id:"substrate"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#substrate","aria-hidden":"true"}},[t._v("#")]),t._v(" substrate")]),t._v(" "),r("p",[r("strong",[t._v("● substrate")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/types.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/136.9dcd2366.js b/docs/assets/js/136.9dcd2366.js deleted file mode 100644 index d97e808b47..0000000000 --- a/docs/assets/js/136.9dcd2366.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{512:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),a("p",[a("strong",[e._v("CreateItemOptions")])]),e._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),a("p",[a("a",{attrs:{id:"isunhashed"}})]),e._v(" "),a("h2",{attrs:{id:"optional-isunhashed"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#optional-isunhashed","aria-hidden":"true"}},[e._v("#")]),e._v(" "),a("code",[e._v("")]),e._v(" isUnhashed")]),e._v(" "),a("p",[a("strong",[e._v("● isUnhashed")]),e._v(": "),a("em",[a("code",[e._v("undefined")]),e._v(" | "),a("code",[e._v("false")]),e._v(" | "),a("code",[e._v("true")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/utils/createFunction.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("utils/createFunction.ts:12"),a("OutboundLink")],1)])]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"key"}})]),e._v(" "),a("h2",{attrs:{id:"optional-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#optional-key","aria-hidden":"true"}},[e._v("#")]),e._v(" "),a("code",[e._v("")]),e._v(" key")]),e._v(" "),a("p",[a("strong",[e._v("● key")]),e._v(": "),a("em",[a("code",[e._v("undefined")]),e._v(" | "),a("code",[e._v("string")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/utils/createFunction.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("utils/createFunction.ts:13"),a("OutboundLink")],1)])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/137.cdee1656.js b/docs/assets/js/137.cdee1656.js deleted file mode 100644 index 2101e89c38..0000000000 --- a/docs/assets/js/137.cdee1656.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[137],{513:function(t,a,e){"use strict";e.r(a);var r=e(46),o=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"frommetadata"}})]),t._v(" "),e("h2",{attrs:{id:"frommetadata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#frommetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" fromMetadata")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fromMetadata")]),t._v("(metadata: "),e("em",[e("code",[t._v("MetadataV0")])]),t._v("): "),e("router-link",{attrs:{to:"/type-storage/interfaces/_types_.storage.html"}},[t._v("Storage")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/fromMetadata.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("fromMetadata.ts:20"),e("OutboundLink")],1)])]),t._v(" "),e("p",[t._v("Extend a storage object with the storage modules & module functions present in the metadata.")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("metadata")]),t._v(" "),e("td",[e("code",[t._v("MetadataV0")])]),t._v(" "),e("td",[t._v("The metadata to extend the storage object against.")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/type-storage/interfaces/_types_.storage.html"}},[t._v("Storage")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/138.39184086.js b/docs/assets/js/138.39184086.js deleted file mode 100644 index 2c435fa198..0000000000 --- a/docs/assets/js/138.39184086.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{515:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/139.f90df65f.js b/docs/assets/js/139.f90df65f.js deleted file mode 100644 index 0e89e7b077..0000000000 --- a/docs/assets/js/139.f90df65f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{516:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"object-literals"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#object-literals","aria-hidden":"true"}},[t._v("#")]),t._v(" Object literals")]),t._v(" "),r("p",[r("a",{attrs:{id:"storage"}})]),t._v(" "),r("h2",{attrs:{id:"const-storage"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-storage","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" storage")]),t._v(" "),r("p",[r("strong",[t._v("storage")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/storage.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("storage.ts:8"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("a",{attrs:{id:"storage.substrate"}})]),t._v(" "),r("h3",{attrs:{id:"substrate"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#substrate","aria-hidden":"true"}},[t._v("#")]),t._v(" substrate")]),t._v(" "),r("p",[r("strong",[t._v("● substrate")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/type-storage/modules/_substrate_.html"}},[t._v('"substrate"')])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/storage.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("storage.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/14.8212f44f.js b/docs/assets/js/14.8212f44f.js deleted file mode 100644 index 3c2c96842f..0000000000 --- a/docs/assets/js/14.8212f44f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{715:function(e,t,r){"use strict";r.r(t);var a=r(46),v=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": ReferendumInfoExtended")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A [[ReferendumInfo]] with an additional "),r("code",[e._v("index")]),e._v(" field")]),e._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("ConstructorDef")])]),e._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("code",[e._v("object")])]),e._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[e._v("#")]),e._v(" V : "),r("code",[e._v("object")])]),e._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[e._v("#")]),e._v(" E : "),r("code",[e._v("object")])]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("code",[e._v("ReferendumInfo")])]),e._v(" "),r("p",[r("strong",[e._v("↳ ReferendumInfoExtended")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("code",[e._v("Codec")])])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ReferendumInfoExtended")]),e._v("(value: "),r("em",[r("code",[e._v("ReferendumInfo")]),e._v(" | "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1),e._v(", index?: "),r("em",[r("code",[e._v("BN")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides ReferendumInfo.__constructor")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfo.ts:20"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("ReferendumInfo")]),e._v(" | "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1)]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("BN")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[r("code",[e._v("string")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),e._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[e._v("#")]),e._v(" size")]),e._v(" "),r("p",[r("strong",[e._v("● size")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.size")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" Type")]),e._v(" "),r("p",[r("strong",[e._v("get Type")]),e._v("(): "),r("code",[e._v("E")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.Type")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the Type description to sthe structure")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("E")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"delay"}})]),e._v(" "),r("h2",{attrs:{id:"delay"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delay","aria-hidden":"true"}},[e._v("#")]),e._v(" delay")]),e._v(" "),r("p",[r("strong",[e._v("get delay")]),e._v("(): "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.delay")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The delay (in blocks) to wait after a successful referendum before deploying")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.encodedLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"end"}})]),e._v(" "),r("h2",{attrs:{id:"end"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#end","aria-hidden":"true"}},[e._v("#")]),e._v(" end")]),e._v(" "),r("p",[r("strong",[e._v("get end")]),e._v("(): "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.end")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:37"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": When voting on this referendum will end")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("BlockNumber")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("ReferendumIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfo.ts:33"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Convenience getter, returns the referendumIndex")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("ReferendumIndex")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.isEmpty")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"proposal"}})]),e._v(" "),r("h2",{attrs:{id:"proposal"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#proposal","aria-hidden":"true"}},[e._v("#")]),e._v(" proposal")]),e._v(" "),r("p",[r("strong",[e._v("get proposal")]),e._v("(): "),r("code",[e._v("Proposal")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.proposal")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:44"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The proposal being voted on")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Proposal")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"threshold"}})]),e._v(" "),r("h2",{attrs:{id:"threshold"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#threshold","aria-hidden":"true"}},[e._v("#")]),e._v(" threshold")]),e._v(" "),r("p",[r("strong",[e._v("get threshold")]),e._v("(): "),r("code",[e._v("VoteThreshold")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from ReferendumInfo.threshold")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/type/ReferendumInfo.ts:51"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The thresholding mechanism to determine whether it passed")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("VoteThreshold")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),e._v(" "),r("p",[e._v("Returns an iterable of entries in the map.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),e._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[e._v("#")]),e._v(" clear")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("clear")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.clear")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),e._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[e._v("#")]),e._v(" delete")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("delete")]),e._v("(key: "),r("em",[r("code",[e._v("keyof S")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.delete")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("keyof S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the map.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("keyof S")]),e._v(", "),r("code",[e._v("Codec")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.eq")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),e._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[e._v("#")]),e._v(" get")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("get")]),e._v("(name: "),r("em",[r("code",[e._v("keyof S")])]),e._v("): "),r("code",[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.get")])]),e._v(" "),r("p",[r("em",[e._v("Overrides Map.get")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a specific names entry in the structure")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("name")]),e._v(" "),r("td",[r("code",[e._v("keyof S")])]),e._v(" "),r("td",[e._v("The name of the entry to retrieve")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),e._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[e._v("#")]),e._v(" getAtIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getAtIndex")]),e._v("(index: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Codec")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.getAtIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("index")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Codec")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),e._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[e._v("#")]),e._v(" has")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("has")]),e._v("(key: "),r("em",[r("code",[e._v("keyof S")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.has")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("keyof S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("keyof S")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("keyof S")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(key: "),r("em",[r("code",[e._v("keyof S")])]),e._v(", value: "),r("em",[r("code",[e._v("Codec")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("keyof S")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Codec")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toArray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toHex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Overrides Struct.toJSON")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfo.ts:40"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Creates the JSON representation")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.toU8a")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("Codec")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("Constructor")]),e._v("<"),r("code",[e._v("Struct")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Struct.with")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[e._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("ConstructorDef")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Constructor")]),e._v("<"),r("code",[e._v("Struct")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/140.df0fdbee.js b/docs/assets/js/140.df0fdbee.js deleted file mode 100644 index e06f238955..0000000000 --- a/docs/assets/js/140.df0fdbee.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{518:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"variables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),r("p",[r("a",{attrs:{id:"authoritycount"}})]),t._v(" "),r("h2",{attrs:{id:"const-authoritycount"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-authoritycount","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" authorityCount")]),t._v(" "),r("p",[r("strong",[t._v("● authorityCount")]),t._v(": "),r("em",[r("code",[t._v("StorageFunction")])]),t._v(" = createRuntimeFunction('authorityCount', ':auth:len', {\ndocumentation: 'Number of authorities.',\ntype: 'u32'\n})")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("substrate.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"authorityprefix"}})]),t._v(" "),r("h2",{attrs:{id:"const-authorityprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-authorityprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" authorityPrefix")]),t._v(" "),r("p",[r("strong",[t._v("● authorityPrefix")]),t._v(": "),r("em",[r("code",[t._v("StorageFunction")])]),t._v(" = createRuntimeFunction('authorityPrefix', ':auth:', {\ndocumentation: 'Prefix under which authorities are storied.',\ntype: 'u32'\n})")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[t._v("substrate.ts:49"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"changestrieconfig"}})]),t._v(" "),r("h2",{attrs:{id:"const-changestrieconfig"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-changestrieconfig","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" changesTrieConfig")]),t._v(" "),r("p",[r("strong",[t._v("● changesTrieConfig")]),t._v(": "),r("em",[r("code",[t._v("StorageFunction")])]),t._v(" = createRuntimeFunction('changesTrieConfig', ':changes_trie', {\ndocumentation: 'Changes trie configuration is stored under this key.',\ntype: 'u32'\n})")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("substrate.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"code"}})]),t._v(" "),r("h2",{attrs:{id:"const-code"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-code","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" code")]),t._v(" "),r("p",[r("strong",[t._v("● code")]),t._v(": "),r("em",[r("code",[t._v("StorageFunction")])]),t._v(" = createRuntimeFunction('code', ':code', {\ndocumentation: 'Wasm code of the runtime.',\ntype: 'Bytes'\n})")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("substrate.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"extrinsicindex"}})]),t._v(" "),r("h2",{attrs:{id:"const-extrinsicindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-extrinsicindex","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" extrinsicIndex")]),t._v(" "),r("p",[r("strong",[t._v("● extrinsicIndex")]),t._v(": "),r("em",[r("code",[t._v("StorageFunction")])]),t._v(" = createRuntimeFunction('extrinsicIndex', ':extrinsic_index', {\ndocumentation: 'Current extrinsic index (u32) is stored under this key.',\ntype: 'u32'\n})")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("substrate.ts:54"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"heappages"}})]),t._v(" "),r("h2",{attrs:{id:"const-heappages"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-heappages","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" heapPages")]),t._v(" "),r("p",[r("strong",[t._v("● heapPages")]),t._v(": "),r("em",[r("code",[t._v("StorageFunction")])]),t._v(" = createRuntimeFunction('heapPages', ':heappages', {\ndocumentation: 'Number of wasm linear memory pages required for execution of the runtime.',\ntype: 'u64'\n})")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("substrate.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/141.3ac35658.js b/docs/assets/js/141.3ac35658.js deleted file mode 100644 index f52b9f9b14..0000000000 --- a/docs/assets/js/141.3ac35658.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{519:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/type-storage/interfaces/_types_.modulestorage.html"}},[t._v("ModuleStorage")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/type-storage/interfaces/_types_.storage.html"}},[t._v("Storage")])],1)]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/142.b2cceeea.js b/docs/assets/js/142.b2cceeea.js deleted file mode 100644 index b3dcbfd39b..0000000000 --- a/docs/assets/js/142.b2cceeea.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[142],{521:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/type-storage/interfaces/_utils_createfunction_.createitemoptions.html"}},[t._v("CreateItemOptions")])],1)]),t._v(" "),a("h3",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/type-storage/modules/_utils_createfunction_.html#createfunction"}},[t._v("createFunction")])],1)]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"functions-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"createfunction"}})]),t._v(" "),a("h2",{attrs:{id:"createfunction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#createfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" createFunction")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("createFunction")]),t._v("(section: "),a("em",[a("code",[t._v("Text")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", method: "),a("em",[a("code",[t._v("Text")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", meta: "),a("em",[a("code",[t._v("StorageFunctionMetadata")])]),t._v(", options?: "),a("em",[a("router-link",{attrs:{to:"/type-storage/interfaces/_utils_createfunction_.createitemoptions.html"}},[t._v("CreateItemOptions")])],1),t._v("): "),a("code",[t._v("StorageFunction")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/utils/createFunction.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("utils/createFunction.ts:26"),a("OutboundLink")],1)])]),t._v(" "),a("p",[t._v("From the schema of a function in the module's storage, generate the function that will return the correct storage key.")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("section")]),t._v(" "),a("td",[a("code",[t._v("Text")]),t._v(" | "),a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("-")]),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("method")]),t._v(" "),a("td",[a("code",[t._v("Text")]),t._v(" | "),a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("-")]),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[t._v("meta")]),t._v(" "),a("td",[a("code",[t._v("StorageFunctionMetadata")])]),t._v(" "),a("td",[t._v("-")]),t._v(" "),a("td")]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/type-storage/interfaces/_utils_createfunction_.createitemoptions.html"}},[t._v("CreateItemOptions")])],1),t._v(" "),a("td",[t._v("{}")]),t._v(" "),a("td",[t._v("Additional options when creating the function. These options are not known at runtime (from state_getMetadata), they need to be supplied by us manually at compile time.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("StorageFunction")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/143.580c8451.js b/docs/assets/js/143.580c8451.js deleted file mode 100644 index 5b6b5fbfef..0000000000 --- a/docs/assets/js/143.580c8451.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{522:function(t,e,s){"use strict";s.r(e);var r=s(46),_=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"polkadot-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-types","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/types")]),t._v(" "),s("p",[t._v("Implementation of the types and their (de-)serialisation via "),s("a",{attrs:{href:"https://github.com/paritytech/parity-codec",target:"_blank",rel:"noopener noreferrer"}},[t._v("parity-codec"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("h2",{attrs:{id:"primitive-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#primitive-types","aria-hidden":"true"}},[t._v("#")]),t._v(" Primitive types")]),t._v(" "),s("p",[t._v("There primitive types are available: "),s("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[t._v("Data")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[t._v("H160")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[t._v("H256")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[t._v("H512")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[t._v("I8")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[t._v("I16")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[t._v("I32")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[t._v("I64")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[t._v("I128")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[t._v("I256")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("StorageData")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("StorageKey")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[t._v("U8")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[t._v("U64")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[t._v("U128")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[t._v("U256")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1),t._v(" "),s("h2",{attrs:{id:"substrate-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#substrate-types","aria-hidden":"true"}},[t._v("#")]),t._v(" Substrate types")]),t._v(" "),s("p",[t._v("These types implement specific types that are found as part of the Substrate base: "),s("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("AccountIndex")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[t._v("Amount")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[t._v("AssetOf")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("AuthorityId")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[t._v("BalanceOf")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[t._v("CodeHash")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[t._v("InherentOfflineReport")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("KeyValue")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[t._v("NewAccountOutcome")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("Origin")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[t._v("ParaId")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[t._v("Perbill")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[t._v("Permill")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("PrefabWasmModule")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[t._v("PropIndex")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[t._v("ProposalIndex")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[t._v("ReferendumIndex")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("ReferendumInfo")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("Schedule")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[t._v("SeedOf")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[t._v("SessionKey")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("StoredPendingChange")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("VestingSchedule")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[t._v("Vote")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[t._v("VoteIndex")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[t._v("VoteThreshold")])],1),t._v(" "),s("h2",{attrs:{id:"codec-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#codec-types","aria-hidden":"true"}},[t._v("#")]),t._v(" Codec types")]),t._v(" "),s("p",[t._v("These are the base types of the codec, typically not used directly, but rather inherited from to create specific types: "),s("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(", "),s("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#enum"}},[t._v("Enum")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[t._v("Set")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[t._v("U8a")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[t._v("U8aFixed")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")])],1),t._v(" "),s("h2",{attrs:{id:"rpc-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#rpc-types","aria-hidden":"true"}},[t._v("#")]),t._v(" RPC types")]),t._v(" "),s("p",[t._v("These types are not used in the runtime, but rather are used in RPC results: "),s("router-link",{attrs:{to:"/types/classes/_rpc_chainproperties_.chainproperties.html"}},[t._v("ChainProperties")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_health_.health.html"}},[t._v("Health")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_networkstate_.networkstate.html"}},[t._v("NetworkState")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_peerinfo_.peerinfo.html"}},[t._v("PeerInfo")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html"}},[t._v("PendingExtrinsics")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_signedblock_.signedblock.html"}},[t._v("SignedBlock")]),t._v(", "),s("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1),t._v(" "),s("h2",{attrs:{id:"derived-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#derived-types","aria-hidden":"true"}},[t._v("#")]),t._v(" Derived types")]),t._v(" "),s("p",[t._v("Some types are extended from the base to provide additional information: "),s("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[t._v("HeaderExtended")]),t._v(", [[ReferendumInfoExtended]]")],1)])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/144.68e753bb.js b/docs/assets/js/144.68e753bb.js deleted file mode 100644 index c608929893..0000000000 --- a/docs/assets/js/144.68e753bb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{491:function(t,e,s){"use strict";s.r(e);var _=s(46),l=Object(_.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("ul",[s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_magicnumber_.html"}},[t._v('"Metadata/MagicNumber"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[t._v("MagicNumber")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_metadata_.html"}},[t._v('"Metadata/Metadata"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_metadataversioned_.html"}},[t._v('"Metadata/MetadataVersioned"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_static_.html"}},[t._v('"Metadata/static"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_types_.html"}},[t._v('"Metadata/types"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_util_flattenuniq_.html"}},[t._v('"Metadata/util/flattenUniq"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_util_validatetypes_.html"}},[t._v('"Metadata/util/validateTypes"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v0_calls_.html"}},[t._v('"Metadata/v0/Calls"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("OuterDispatchMetadata")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v0_events_.html"}},[t._v('"Metadata/v0/Events"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("OuterEventMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v0_metadata_.html"}},[t._v('"Metadata/v0/Metadata"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v0_modules_.html"}},[t._v('"Metadata/v0/Modules"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[t._v("StorageFunctionModifier")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[t._v("StorageFunctionType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v0_static_.html"}},[t._v('"Metadata/v0/static"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v1_calls_.html"}},[t._v('"Metadata/v1/Calls"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v1_events_.html"}},[t._v('"Metadata/v1/Events"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v1_metadata_.html"}},[t._v('"Metadata/v1/Metadata"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v1_storage_.html"}},[t._v('"Metadata/v1/Storage"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.default.html"}},[t._v("Default")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[t._v("MetadataStorageModifier")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[t._v("MetadataStorageType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.optional.html"}},[t._v("Optional")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[t._v("PlainType")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v1_static_.html"}},[t._v('"Metadata/v1/static"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_metadata_v1_tov0_.html"}},[t._v('"Metadata/v1/toV0"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_classes_.html"}},[t._v('"classes"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html"}},[t._v('"codec/AbstractInt"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_base_.html"}},[t._v('"codec/Base"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_compact_.html"}},[t._v('"codec/Compact"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_enum_.html"}},[t._v('"codec/Enum"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[t._v("Enum")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_enumtype_.html"}},[t._v('"codec/EnumType"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_int_.html"}},[t._v('"codec/Int"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[t._v("Int")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_option_.html"}},[t._v('"codec/Option"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_set_.html"}},[t._v('"codec/Set"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[t._v("Set")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_struct_.html"}},[t._v('"codec/Struct"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_tuple_.html"}},[t._v('"codec/Tuple"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_u8a_.html"}},[t._v('"codec/U8a"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[t._v("U8a")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_u8afixed_.html"}},[t._v('"codec/U8aFixed"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[t._v("U8aFixed")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_uint_.html"}},[t._v('"codec/UInt"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_vector_.html"}},[t._v('"codec/Vector"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html"}},[t._v('"codec/createType"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html"}},[t._v("TypeDefInfo")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_typeregistry_.html"}},[t._v('"codec/typeRegistry"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_typeregistry_.typeregistry.html"}},[t._v("TypeRegistry")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_utils_comparearray_.html"}},[t._v('"codec/utils/compareArray"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_utils_comparemap_.html"}},[t._v('"codec/utils/compareMap"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_codec_utils_decodeu8a_.html"}},[t._v('"codec/utils/decodeU8a"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_index_types_.html"}},[t._v('"index.types"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_bool_.html"}},[t._v('"primitive/Bool"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_bytes_.html"}},[t._v('"primitive/Bytes"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_data_.html"}},[t._v('"primitive/Data"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[t._v("Data")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_h160_.html"}},[t._v('"primitive/H160"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[t._v("H160")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_h256_.html"}},[t._v('"primitive/H256"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[t._v("H256")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_h512_.html"}},[t._v('"primitive/H512"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[t._v("H512")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_i128_.html"}},[t._v('"primitive/I128"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[t._v("I128")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_i16_.html"}},[t._v('"primitive/I16"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[t._v("I16")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_i256_.html"}},[t._v('"primitive/I256"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[t._v("I256")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_i32_.html"}},[t._v('"primitive/I32"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[t._v("I32")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_i64_.html"}},[t._v('"primitive/I64"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[t._v("I64")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_i8_.html"}},[t._v('"primitive/I8"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[t._v("I8")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_method_.html"}},[t._v('"primitive/Method"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.methodindex.html"}},[t._v("MethodIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methodfunction.html"}},[t._v("MethodFunction")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methods.html"}},[t._v("Methods")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.moduleswithmethods.html"}},[t._v("ModulesWithMethods")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_moment_.html"}},[t._v('"primitive/Moment"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.momentof.html"}},[t._v("MomentOf")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_null_.html"}},[t._v('"primitive/Null"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_storagedata_.html"}},[t._v('"primitive/StorageData"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("StorageData")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_storagekey_.html"}},[t._v('"primitive/StorageKey"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("StorageKey")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[t._v("StorageFunction")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_text_.html"}},[t._v('"primitive/Text"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_type_.html"}},[t._v('"primitive/Type"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_u128_.html"}},[t._v('"primitive/U128"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[t._v("U128")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_u16_.html"}},[t._v('"primitive/U16"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_u256_.html"}},[t._v('"primitive/U256"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[t._v("U256")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_u32_.html"}},[t._v('"primitive/U32"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_u64_.html"}},[t._v('"primitive/U64"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[t._v("U64")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_u8_.html"}},[t._v('"primitive/U8"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[t._v("U8")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_primitive_usize_.html"}},[t._v('"primitive/USize"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_chainproperties_.html"}},[t._v('"rpc/ChainProperties"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_chainproperties_.chainproperties.html"}},[t._v("ChainProperties")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_extrinsicstatus_.html"}},[t._v('"rpc/ExtrinsicStatus"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[t._v("Finalised")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[t._v("Usurped")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_health_.html"}},[t._v('"rpc/Health"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_health_.health.html"}},[t._v("Health")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_json_.html"}},[t._v('"rpc/Json"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_networkstate_.html"}},[t._v('"rpc/NetworkState"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_networkstate_.networkstate.html"}},[t._v("NetworkState")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_peerinfo_.html"}},[t._v('"rpc/PeerInfo"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_peerinfo_.peerinfo.html"}},[t._v("PeerInfo")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_pendingextrinsics_.html"}},[t._v('"rpc/PendingExtrinsics"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html"}},[t._v("PendingExtrinsics")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_runtimeversion_.html"}},[t._v('"rpc/RuntimeVersion"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[t._v("ApiId")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[t._v("RuntimeVersionApi")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_signedblock_.html"}},[t._v('"rpc/SignedBlock"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_signedblock_.signedblock.html"}},[t._v("SignedBlock")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_rpc_storagechangeset_.html"}},[t._v('"rpc/StorageChangeSet"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_scripts_metadatamd_.html"}},[t._v('"scripts/MetadataMd"')])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_accountid_.html"}},[t._v('"type/AccountId"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountidof.html"}},[t._v("AccountIdOf")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_accountindex_.html"}},[t._v('"type/AccountIndex"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("AccountIndex")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_address_.html"}},[t._v('"type/Address"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_amount_.html"}},[t._v('"type/Amount"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[t._v("Amount")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_assetof_.html"}},[t._v('"type/AssetOf"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[t._v("AssetOf")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_attestedcandidate_.html"}},[t._v('"type/AttestedCandidate"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.availabilityvote.html"}},[t._v("AvailabilityVote")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.balanceupload.html"}},[t._v("BalanceUpload")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("CandidateReceipt")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[t._v("CandidateSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.egressqueueroot.html"}},[t._v("EgressQueueRoot")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("ExplicitCandidateSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.headdata.html"}},[t._v("HeadData")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("ImplicitCandidateSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityattestation.html"}},[t._v("ValidityAttestation")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityvote.html"}},[t._v("ValidityVote")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_authorityid_.html"}},[t._v('"type/AuthorityId"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("AuthorityId")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_balance_.html"}},[t._v('"type/Balance"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[t._v("BalanceOf")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_bft_.html"}},[t._v('"type/Bft"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("BftAuthoritySignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_block_.html"}},[t._v('"type/Block"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_blocknumber_.html"}},[t._v('"type/BlockNumber"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_codehash_.html"}},[t._v('"type/CodeHash"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[t._v("CodeHash")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_digest_.html"}},[t._v('"type/Digest"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[t._v("AuthoritiesChange")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[t._v("ChangesTrieRoot")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[t._v("DigestItem")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[t._v("Other")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[t._v("Seal")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_event_.html"}},[t._v('"type/Event"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("EventData")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[t._v("EventIndex")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_eventrecord_.html"}},[t._v('"type/EventRecord"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[t._v("ApplyExtrinsic")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[t._v("Finalization")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_extrinsic_.html"}},[t._v('"type/Extrinsic"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_extrinsicera_.html"}},[t._v('"type/ExtrinsicEra"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_extrinsicsignature_.html"}},[t._v('"type/ExtrinsicSignature"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_extrinsics_.html"}},[t._v('"type/Extrinsics"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("Extrinsics")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_gas_.html"}},[t._v('"type/Gas"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_hash_.html"}},[t._v('"type/Hash"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_header_.html"}},[t._v('"type/Header"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[t._v("HeaderExtended")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_inherentofflinereport_.html"}},[t._v('"type/InherentOfflineReport"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[t._v("InherentOfflineReport")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_justification_.html"}},[t._v('"type/Justification"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("RhdJustification")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_keyvalue_.html"}},[t._v('"type/KeyValue"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("KeyValue")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("KeyValueOption")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_lockperiods_.html"}},[t._v('"type/LockPeriods"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_lockperiods_.lockperiods.html"}},[t._v("LocKPeriods")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_misbehaviorreport_.html"}},[t._v('"type/MisbehaviorReport"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[t._v("BftDoubleCommit")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[t._v("BftDoublePrepare")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[t._v("BftDoublePropose")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("BftProposeOutOfTurn")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[t._v("MisbehaviorKind")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_newaccountoutcome_.html"}},[t._v('"type/NewAccountOutcome"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[t._v("NewAccountOutcome")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_nonce_.html"}},[t._v('"type/Nonce"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_noncecompact_.html"}},[t._v('"type/NonceCompact"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_noncecompact_.noncecompact.html"}},[t._v("NonceCompact")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_origin_.html"}},[t._v('"type/Origin"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("Origin")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_paraid_.html"}},[t._v('"type/ParaId"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[t._v("ParaId")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_perbill_.html"}},[t._v('"type/Perbill"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[t._v("Perbill")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_permill_.html"}},[t._v('"type/Permill"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[t._v("Permill")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_prefabwasmmodule_.html"}},[t._v('"type/PrefabWasmModule"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("PrefabWasmModule")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_propindex_.html"}},[t._v('"type/PropIndex"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[t._v("PropIndex")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_proposal_.html"}},[t._v('"type/Proposal"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_proposalindex_.html"}},[t._v('"type/ProposalIndex"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[t._v("ProposalIndex")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_referendumindex_.html"}},[t._v('"type/ReferendumIndex"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[t._v("ReferendumIndex")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_referenduminfo_.html"}},[t._v('"type/ReferendumInfo"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("ReferendumInfo")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_schedule_.html"}},[t._v('"type/Schedule"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("Schedule")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_seedof_.html"}},[t._v('"type/SeedOf"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[t._v("SeedOf")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_sessionkey_.html"}},[t._v('"type/SessionKey"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[t._v("SessionKey")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_signature_.html"}},[t._v('"type/Signature"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.ed25519signature.html"}},[t._v("Ed25519Signature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.sr25519signature.html"}},[t._v("Sr25519Signature")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_signaturepayload_.html"}},[t._v('"type/SignaturePayload"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_storedpendingchange_.html"}},[t._v('"type/StoredPendingChange"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[t._v("NextAuthority")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("StoredPendingChange")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_validatorprefs_.html"}},[t._v('"type/ValidatorPrefs"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_vestingschedule_.html"}},[t._v('"type/VestingSchedule"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("VestingSchedule")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_vote_.html"}},[t._v('"type/Vote"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[t._v("Vote")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_voteindex_.html"}},[t._v('"type/VoteIndex"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[t._v("VoteIndex")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_type_votethreshold_.html"}},[t._v('"type/VoteThreshold"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[t._v("VoteThreshold")])],1)])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_types_.runtimeversioninterface.html"}},[t._v("RuntimeVersionInterface")])],1)])],1)])])},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/145.340cc950.js b/docs/assets/js/145.340cc950.js deleted file mode 100644 index eb6c7440d1..0000000000 --- a/docs/assets/js/145.340cc950.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[145],{524:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": Base")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": A type extends the Base class, when it holds a value")]),t._v(" "),s("h1",{attrs:{id:"type-parameters"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),s("h4",{attrs:{id:"t"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#t","aria-hidden":"true"}},[t._v("#")]),t._v(" T")]),t._v(" "),s("h1",{attrs:{id:"hierarchy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),s("p",[s("strong",[t._v("Base")])]),t._v(" "),s("p",[t._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")])],1),t._v(" "),s("p",[t._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),s("p",[t._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")])],1),t._v(" "),s("p",[t._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[t._v("Enum")])],1),t._v(" "),s("p",[t._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1),t._v(" "),s("p",[t._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[t._v("Set")])],1),t._v(" "),s("h1",{attrs:{id:"constructors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),s("p",[s("a",{attrs:{id:"constructor"}})]),t._v(" "),s("h2",{attrs:{id:"constructor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),s("p",[t._v("⊕ "),s("strong",[t._v("new Base")]),t._v("(value?: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Base.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Base.ts:10"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")])],1),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/146.cf86a887.js b/docs/assets/js/146.cf86a887.js deleted file mode 100644 index 1a14fc43bf..0000000000 --- a/docs/assets/js/146.cf86a887.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{700:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Compact")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A compact length-encoding codec wrapper. It performs the same function as Length, however differs in that it uses a variable number of bytes to do the actual encoding. This is mostly used by other types to add length-prefixed encoding, or in the case of wrapped types, taking a number and making the compact representation thereof")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v(" "),r("p",[r("strong",[t._v("↳ Compact")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_noncecompact_.noncecompact.html"}},[t._v("NonceCompact")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Compact")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(" "),r("td",[t._v("0")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"addlengthprefix"}})]),t._v(" "),r("h2",{attrs:{id:"static-addlengthprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-addlengthprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" addLengthPrefix")]),t._v(" "),r("p",[r("strong",[t._v("● addLengthPrefix")]),t._v(": "),r("em",[r("code",[t._v("compactAddLength")])]),t._v(" = compactAddLength")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[t._v("Prepend a Uint8Array with its compact length.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("param")])]),t._v(": The Uint8Array to be prefixed")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeU8a")]),t._v(" "),r("p",[r("strong",[t._v("● decodeU8a")]),t._v(": "),r("em",[r("code",[t._v("compactFromU8a")])]),t._v(" = compactFromU8a")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"static-encodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-encodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" encodeU8a")]),t._v(" "),r("p",[r("strong",[t._v("● encodeU8a")]),t._v(": "),r("em",[r("code",[t._v("compactToU8a")])]),t._v(" = compactToU8a")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:43"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:72"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:79"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),t._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" bitLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("bitLength")]),t._v("(): "),r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:86"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the number of bits in the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:93"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tobn"}})]),t._v(" "),r("h2",{attrs:{id:"tobn"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[t._v("#")]),t._v(" toBn")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toBn")]),t._v("(): "),r("code",[t._v("BN")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L104",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:104"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the BN representation of the number")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("BN")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L111",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:111"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L118",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:118"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),t._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" toNumber")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toNumber")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the number representation for the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:132"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:140"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"unwrap"}})]),t._v(" "),r("h2",{attrs:{id:"unwrap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unwrap","aria-hidden":"true"}},[t._v("#")]),t._v(" unwrap")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("unwrap")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L147",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:147"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the embedded "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" or "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" value")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodecompact"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodecompact"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodecompact","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeCompact")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeCompact")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1)]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"striplengthprefix"}})]),t._v(" "),r("h2",{attrs:{id:"static-striplengthprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-striplengthprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" stripLengthPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stripLengthPrefix")]),t._v("(u8a: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("u8a")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])]),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(">")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/147.e8467d58.js b/docs/assets/js/147.e8467d58.js deleted file mode 100644 index 5a63b6a89a..0000000000 --- a/docs/assets/js/147.e8467d58.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[147],{757:function(e,t,r){"use strict";r.r(t);var s=r(46),o=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Enum")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A codec wrapper for an enum. Enums are encoded as a single byte, where the byte is a zero-indexed value. This class allows you to retrieve the value either by "),r("code",[e._v("toNumber()")]),e._v(" exposing the actual raw index, or "),r("code",[e._v("toString()")]),e._v(" returning a string representation (as provided as part of the constructor)")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[e._v("Base")]),e._v("<"),r("code",[e._v("number")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("↳ Enum")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[e._v("StorageFunctionModifier")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[e._v("NewAccountOutcome")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[e._v("VoteThreshold")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Enum")]),e._v("(def: "),r("em",[r("code",[e._v("EnumDef")])]),e._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:29"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("def")]),e._v(" "),r("td",[r("code",[e._v("EnumDef")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1),e._v(" "),r("td",[e._v("0")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:64"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:71"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value (always false)")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:78"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:112"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:120"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeenum"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodeenum"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeenum","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeEnum")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeEnum")]),e._v("(def: "),r("em",[r("code",[e._v("EnumDef")])]),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:47"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("def")]),e._v(" "),r("td",[r("code",[e._v("EnumDef")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/148.d62977b0.js b/docs/assets/js/148.d62977b0.js deleted file mode 100644 index 4cc33daf41..0000000000 --- a/docs/assets/js/148.d62977b0.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[148],{525:function(e,t,r){"use strict";r.r(t);var s=r(46),a=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": EnumType")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": This implements an enum, that based on the value wraps a different type. It is effectively an extension to enum where the value type is determined by the actual index.")]),e._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"t"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t","aria-hidden":"true"}},[e._v("#")]),e._v(" T")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[e._v("Base")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("↳ EnumType")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[e._v("StorageFunctionType")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[e._v("MetadataStorageModifier")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[e._v("MetadataStorageType")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[e._v("ExtrinsicStatus")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[e._v("DigestItem")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityattestation.html"}},[e._v("ValidityAttestation")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[e._v("Phase")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[e._v("MisbehaviorKind")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new EnumType")]),e._v("(def: "),r("em",[r("code",[e._v("TypesDef")])]),e._v(", value?: "),r("em",[r("code",[e._v("any")])]),e._v(", index?: "),r("em",[r("code",[e._v("number")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:35"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("def")]),e._v(" "),r("td",[r("code",[e._v("TypesDef")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("any")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("number")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The index of the metadata value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:128"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),e._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[e._v("#")]),e._v(" isNone")]),e._v(" "),r("p",[r("strong",[e._v("get isNone")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:135"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnull"}})]),e._v(" "),r("h2",{attrs:{id:"isnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[e._v("#")]),e._v(" isNull")]),e._v(" "),r("p",[r("strong",[e._v("get isNull")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:142"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type (deprecated, use isNone)")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" type")]),e._v(" "),r("p",[r("strong",[e._v("get type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The name of the type this enum value represents")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:156"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value of the enum")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:163"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:183"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:192"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:199"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:209"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[e._v("ConstructorDef")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/149.4423ac17.js b/docs/assets/js/149.4423ac17.js deleted file mode 100644 index 509db0d033..0000000000 --- a/docs/assets/js/149.4423ac17.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[149],{530:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Int")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A generic signed integer codec. For Substrate all numbers are LE encoded, this handles the encoding and decoding of those numbers. Upon construction the bitLength is provided and any additional use keeps the number to this length. This extends "),r("code",[t._v("BN")]),t._v(", so all methods available on a normal "),r("code",[t._v("BN")]),t._v(" object is available here.")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("AbstractInt")])]),t._v(" "),r("p",[r("strong",[t._v("↳ Int")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[t._v("I8")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[t._v("I16")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[t._v("I32")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[t._v("I64")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[t._v("I128")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[t._v("I256")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Int")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(", bitLength?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(", isHexJson?: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[t._v("Int")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides AbstractInt.__constructor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Int.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(" "),r("td",[t._v("0")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("td",[t._v("DEFAULT_UINT_BITS")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" isHexJson")]),t._v(" "),r("td",[r("code",[t._v("boolean")])]),t._v(" "),r("td",[t._v("true")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[t._v("Int")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides AbstractInt.toHex")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Int.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides AbstractInt.toU8a")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Int.ts:48"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/15.d8a6af32.js b/docs/assets/js/15.d8a6af32.js deleted file mode 100644 index b7e3fd3aa1..0000000000 --- a/docs/assets/js/15.d8a6af32.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{343:function(e,t,n){"use strict";n.r(t);var a=n(46),d=Object(a.a)({},function(){var e=this,t=e.$createElement,n=e._self._c||t;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("h1",{attrs:{id:"type-aliases"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),n("p",[n("a",{attrs:{id:"accountidandindex"}})]),e._v(" "),n("h2",{attrs:{id:"accountidandindex"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#accountidandindex","aria-hidden":"true"}},[e._v("#")]),e._v(" AccountIdAndIndex")]),e._v(" "),n("p",[n("strong",[e._v("Ƭ AccountIdAndIndex")]),e._v(": "),n("em",[e._v("["),n("code",[e._v("undefined")]),e._v(" | "),n("code",[e._v("AccountId")]),e._v(", "),n("code",[e._v("undefined")]),e._v(" | "),n("code",[e._v("AccountIndex")]),e._v("]")])]),e._v(" "),n("p",[n("em",[e._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/idAndIndex.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("accounts/idAndIndex.ts:16"),n("OutboundLink")],1)])]),e._v(" "),n("hr"),e._v(" "),n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),n("p",[n("a",{attrs:{id:"idandindex"}})]),e._v(" "),n("h2",{attrs:{id:"idandindex"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#idandindex","aria-hidden":"true"}},[e._v("#")]),e._v(" idAndIndex")]),e._v(" "),n("p",[e._v("▸ "),n("strong",[e._v("idAndIndex")]),e._v("(api: "),n("em",[n("code",[e._v("ApiInterface$Rx")])]),e._v("): "),n("code",[e._v("(Anonymous function)")])]),e._v(" "),n("p",[n("em",[e._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/idAndIndex.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("accounts/idAndIndex.ts:18"),n("OutboundLink")],1)])]),e._v(" "),n("p",[n("strong",[e._v("Parameters:")])]),e._v(" "),n("table",[n("thead",[n("tr",[n("th",[e._v("Name")]),e._v(" "),n("th",[e._v("Type")])])]),e._v(" "),n("tbody",[n("tr",[n("td",[e._v("api")]),e._v(" "),n("td",[n("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),n("p",[n("strong",[e._v("Returns:")]),e._v(" "),n("code",[e._v("(Anonymous function)")])]),e._v(" "),n("hr")])},[],!1,null,null,null);t.default=d.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/150.27c79c1e.js b/docs/assets/js/150.27c79c1e.js deleted file mode 100644 index fa3a99da0a..0000000000 --- a/docs/assets/js/150.27c79c1e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[150],{528:function(t,e,r){"use strict";r.r(e);var o=r(46),a=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Option")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": An Option is an optional field. Basically the first byte indicates that there is is value to follow. If the byte is "),r("code",[t._v("1")]),t._v(" there is an actual value. So the Option implements that - decodes, checks for optionality and wraps the required structure with a value if/as required/found.")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"t-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v("<"),r("code",[t._v("T")]),t._v(">")],1),t._v(" "),r("p",[r("strong",[t._v("↳ Option")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Option")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(", value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1)]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:64"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the Option has no value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),t._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[t._v("#")]),t._v(" isNone")]),t._v(" "),r("p",[r("strong",[t._v("get isNone")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the Option has no value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"issome"}})]),t._v(" "),r("h2",{attrs:{id:"issome"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#issome","aria-hidden":"true"}},[t._v("#")]),t._v(" isSome")]),t._v(" "),r("p",[r("strong",[t._v("get isSome")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:78"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the Option has a value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),t._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[t._v("#")]),t._v(" value")]),t._v(" "),r("p",[r("strong",[t._v("get value")]),t._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:85"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The actual value for the Option")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L92",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:92"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L103",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:103"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:110"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L117",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:117"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"unwrap"}})]),t._v(" "),r("h2",{attrs:{id:"unwrap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unwrap","aria-hidden":"true"}},[t._v("#")]),t._v(" unwrap")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("unwrap")]),t._v("(): "),r("code",[t._v("T")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L143",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:143"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the value that the Option represents (if available), throws if null")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("T")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"unwrapor"}})]),t._v(" "),r("h2",{attrs:{id:"unwrapor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unwrapor","aria-hidden":"true"}},[t._v("#")]),t._v(" unwrapOr")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("unwrapOr")]),t._v("<"),r("code",[t._v("O")]),t._v(">(defaultValue: "),r("em",[r("code",[t._v("O")])]),t._v("): "),r("code",[t._v("T")]),t._v(" | "),r("code",[t._v("O")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:155"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the value that the Option represents (if available) or defaultValue if none")]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"o"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o","aria-hidden":"true"}},[t._v("#")]),t._v(" O")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("defaultValue")]),t._v(" "),r("td",[r("code",[t._v("O")])]),t._v(" "),r("td",[t._v("The value to return if the option isNone")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("T")]),t._v(" | "),r("code",[t._v("O")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeoption"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeoption"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeoption","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeOption")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeOption")]),t._v("<"),r("code",[t._v("O")]),t._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(", value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"o-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o-2","aria-hidden":"true"}},[t._v("#")]),t._v(" O")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1)]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("O")]),t._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("code",[t._v("O")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Option.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"o-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o-codec","aria-hidden":"true"}},[t._v("#")]),t._v(" O : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("code",[t._v("O")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/151.f45a01cd.js b/docs/assets/js/151.f45a01cd.js deleted file mode 100644 index 1ad1e9b395..0000000000 --- a/docs/assets/js/151.f45a01cd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[151],{531:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Set")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An Set is an array of string values, represented an an encoded type by a bitwise representation of the values.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[e._v("Base")]),e._v("<"),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">>")],1),e._v(" "),r("p",[r("strong",[e._v("↳ Set")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Set")]),e._v("(setValues: "),r("em",[r("code",[e._v("SetValues")])]),e._v(", value?: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[e._v("Set")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[e._v("Base")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:23"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("setValues")]),e._v(" "),r("td",[r("code",[e._v("SetValues")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[e._v("Set")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": true is the Set contains no values")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"valueencoded"}})]),e._v(" "),r("h2",{attrs:{id:"valueencoded"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#valueencoded","aria-hidden":"true"}},[e._v("#")]),e._v(" valueEncoded")]),e._v(" "),r("p",[r("strong",[e._v("get valueEncoded")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The encoded value for the set members")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[r("strong",[e._v("get values")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The actual set values as a Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L117",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:117"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L124",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:124"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L131",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:131"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L139",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:139"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeset"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodeset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeset","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeSet")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeSet")]),e._v("(setValues: "),r("em",[r("code",[e._v("SetValues")])]),e._v(", value?: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:33"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("setValues")]),e._v(" "),r("td",[r("code",[e._v("SetValues")])]),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("0")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodeset"}})]),e._v(" "),r("h2",{attrs:{id:"static-encodeset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-encodeset","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" encodeSet")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encodeSet")]),e._v("(setValues: "),r("em",[r("code",[e._v("SetValues")])]),e._v(", value: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Set.ts:64"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("setValues")]),e._v(" "),r("td",[r("code",[e._v("SetValues")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/152.9e0ddfd2.js b/docs/assets/js/152.9e0ddfd2.js deleted file mode 100644 index 4e46c3c4f5..0000000000 --- a/docs/assets/js/152.9e0ddfd2.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[152],{697:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Struct")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A Struct defines an Object with key/values - where the values are Codec values. It removes a lot of repetition from the actual coding, define a structure type, pass it the key/Codec values in the constructor and it manages the decoding. It is important that the constructor values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical, it needs to decoded in the specific defined order.")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("strong",[t._v("↳ Struct")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("OuterDispatchMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("OuterEventMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_health_.health.html"}},[t._v("Health")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_peerinfo_.peerinfo.html"}},[t._v("PeerInfo")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("RhdJustification")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_signedblock_.signedblock.html"}},[t._v("SignedBlock")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("KeyValue")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("CandidateReceipt")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("BftProposeOutOfTurn")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("PrefabWasmModule")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("ReferendumInfo")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("Schedule")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("StoredPendingChange")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("VestingSchedule")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Struct")]),t._v("(Types: "),r("em",[r("code",[t._v("S")])]),t._v(", value?: "),r("em",[r("code",[t._v("V")]),t._v(" | "),r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("any")]),t._v(", "),r("code",[t._v("any")]),t._v("> | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")]),t._v(", jsonMap?: "),r("em",[r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("string")]),t._v(">")]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])]),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("V")]),t._v(" | "),r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("any")]),t._v(", "),r("code",[t._v("any")]),t._v("> | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")]),t._v(" "),r("td",[t._v("{} as V")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" jsonMap")]),t._v(" "),r("td",[r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("td",[t._v("new Map()")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),t._v(" "),r("h2",{attrs:{id:"static-map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-map","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" Map")]),t._v(" "),r("p",[r("strong",[t._v("● Map")]),t._v(": "),r("em",[r("code",[t._v("MapConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/153.dd79521c.js b/docs/assets/js/153.dd79521c.js deleted file mode 100644 index 212f51551b..0000000000 --- a/docs/assets/js/153.dd79521c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[153],{533:function(t,e,r){"use strict";r.r(e);var a=r(46),_=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Tuple")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A Tuple defines an anonymous fixed-length array, where each element has its own type. It extends the base JS "),r("code",[t._v("Array")]),t._v(" object.")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("strong",[t._v("↳ Tuple")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[t._v("RuntimeVersionApi")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[t._v("Seal")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("BftAuthoritySignature")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("KeyValueOption")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.balanceupload.html"}},[t._v("BalanceUpload")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.egressqueueroot.html"}},[t._v("EgressQueueRoot")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.availabilityvote.html"}},[t._v("AvailabilityVote")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityvote.html"}},[t._v("ValidityVote")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("EventData")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[t._v("InherentOfflineReport")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[t._v("NextAuthority")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[n: "),r("code",[t._v("number")]),t._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Tuple")]),t._v("(Types: "),r("em",[r("code",[t._v("TupleConstructors")])]),t._v(", value: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("TupleConstructors")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"array"}})]),t._v(" "),r("h2",{attrs:{id:"static-array"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-array","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" Array")]),t._v(" "),r("p",[r("strong",[t._v("● Array")]),t._v(": "),r("em",[r("code",[t._v("ArrayConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1368")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),t._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[t._v("#")]),t._v(" Types")]),t._v(" "),r("p",[r("strong",[t._v("get Types")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The types definition of the tuple")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),t._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[t._v("#")]),t._v(" filter")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("filter")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Overrides Array.filter")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Filters the array with the callback")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])]),t._v(" "),r("td",[t._v("The filter function")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])]),t._v(" "),r("td",[t._v("The `this` object to apply the result to")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),t._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[t._v("#")]),t._v(" map")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("map")]),t._v("<"),r("code",[t._v("U")]),t._v(">(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("U")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Overrides Array.map")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Maps the array with the callback")]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[t._v("#")]),t._v(" U")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])]),t._v(" "),r("td",[t._v("The mapping function")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])]),t._v(" "),r("td",[t._v("The `this` onject to apply the result to")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("U")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Array.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("(Types: "),r("em",[r("code",[t._v("TupleConstructors")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("TupleConstructors")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")]),t._v(">")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/154.d684ed56.js b/docs/assets/js/154.d684ed56.js deleted file mode 100644 index e23fd7198f..0000000000 --- a/docs/assets/js/154.d684ed56.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[154],{534:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("TypeRegistry")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"defaultregistry"}})]),t._v(" "),r("h2",{attrs:{id:"static-defaultregistry"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-defaultregistry","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" defaultRegistry")]),t._v(" "),r("p",[r("strong",[t._v("● defaultRegistry")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_typeregistry_.typeregistry.html"}},[t._v("TypeRegistry")])],1),t._v(" = new TypeRegistry()")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/typeRegistry.ts:12"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/typeRegistry.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"register"}})]),t._v(" "),r("h2",{attrs:{id:"register"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#register","aria-hidden":"true"}},[t._v("#")]),t._v(" register")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("register")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#registrytypes"}},[t._v("RegistryTypes")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("register")]),t._v("(name: "),r("em",[r("code",[t._v("string")])]),t._v(", type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/typeRegistry.ts:16"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#registrytypes"}},[t._v("RegistryTypes")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/typeRegistry.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/155.132e736b.js b/docs/assets/js/155.132e736b.js deleted file mode 100644 index f8c161cf2f..0000000000 --- a/docs/assets/js/155.132e736b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[155],{536:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": U8a")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A basic wrapper around Uint8Array, with no frills and no fuss. It does differ from other implementations wher it will consume the full Uint8Array as passed to it. As such it is meant to be subclassed where the wrapper takes care of the actual lengths instead of used directly.")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("↳ U8a")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[t._v("Data")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[t._v("U8aFixed")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[index: "),r("code",[t._v("number")]),t._v("]: "),r("code",[t._v("number")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new U8a")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[t._v("U8a")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[t._v("U8a")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"uint8array"}})]),t._v(" "),r("h2",{attrs:{id:"static-uint8array"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-uint8array","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("● Uint8Array")]),t._v(": "),r("em",[r("code",[t._v("Uint8ArrayConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2227")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns true if the type wraps an empty/default all-0 value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),t._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[t._v("#")]),t._v(" length")]),t._v(" "),r("p",[r("strong",[t._v("get length")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Uint8Array.length")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),t._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[t._v("#")]),t._v(" subarray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("subarray")]),t._v("(begin: "),r("em",[r("code",[t._v("number")])]),t._v(", end?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Uint8Array.subarray")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("begin")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The position to start at")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" end")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The position to end at")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Uint8Array.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/156.7375610d.js b/docs/assets/js/156.7375610d.js deleted file mode 100644 index 69f47b0937..0000000000 --- a/docs/assets/js/156.7375610d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[156],{479:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": U8aFixed")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant to be used directly, rather is should be subclassed with the specific lengths.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ U8aFixed")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[e._v("H160")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.methodindex.html"}},[e._v("MethodIndex")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[e._v("ApiId")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[e._v("EventIndex")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new U8aFixed")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v(", bitLength?: "),r("em",[r("code",[e._v("BitLength")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v(" "),r("td",[e._v("new Uint8Array()")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" bitLength")]),e._v(" "),r("td",[r("code",[e._v("BitLength")])]),e._v(" "),r("td",[e._v("256")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/157.3015cd77.js b/docs/assets/js/157.3015cd77.js deleted file mode 100644 index 4a7374cd37..0000000000 --- a/docs/assets/js/157.3015cd77.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[157],{537:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": UInt")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A generic unsigned integer codec. For Substrate all numbers are LE encoded, this handles the encoding and decoding of those numbers. Upon construction the bitLength is provided and any additional use keeps the number to this length. This extends "),r("code",[t._v("BN")]),t._v(", so all methods available on a normal "),r("code",[t._v("BN")]),t._v(" object is available here.")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("AbstractInt")])]),t._v(" "),r("p",[r("strong",[t._v("↳ UInt")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[t._v("U8")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[t._v("U64")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[t._v("U128")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[t._v("U256")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new UInt")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(", bitLength?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(", isHexJson?: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides AbstractInt.__constructor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/UInt.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(" "),r("td",[t._v("0")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("td",[t._v("DEFAULT_UINT_BITS")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" isHexJson")]),t._v(" "),r("td",[r("code",[t._v("boolean")])]),t._v(" "),r("td",[t._v("false")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides AbstractInt.toHex")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/UInt.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides AbstractInt.toU8a")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/UInt.ts:48"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/158.3fdd4c6d.js b/docs/assets/js/158.3fdd4c6d.js deleted file mode 100644 index 529930eab0..0000000000 --- a/docs/assets/js/158.3fdd4c6d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[158],{694:function(t,e,r){"use strict";r.r(e);var _=r(46),a=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Vector")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": This manages codec arrays. Internally it keeps track of the length (as decoded) and allows construction with the passed "),r("code",[t._v("Type")]),t._v(" in the constructor. It is an extension to Array, providing specific encoding/decoding on top of the base type.")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"t-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("T")]),t._v(">")]),t._v(" "),r("p",[r("strong",[t._v("↳ Vector")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("Extrinsics")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[t._v("AuthoritiesChange")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[n: "),r("code",[t._v("number")]),t._v("]: "),r("code",[t._v("T")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Vector")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("code",[t._v("T")]),t._v(">")],1),t._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("code",[t._v("any")]),t._v("> | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("code",[t._v("T")]),t._v(">")],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("code",[t._v("any")]),t._v("> | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")],1),t._v(" "),r("td",[t._v("[] as Array")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"array"}})]),t._v(" "),r("h2",{attrs:{id:"static-array"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-array","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" Array")]),t._v(" "),r("p",[r("strong",[t._v("● Array")]),t._v(": "),r("em",[r("code",[t._v("ArrayConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1368")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:66"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The type for the items")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:73"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),t._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[t._v("#")]),t._v(" length")]),t._v(" "),r("p",[r("strong",[t._v("get length")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Array.length")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:82"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:90"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),t._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[t._v("#")]),t._v(" filter")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("filter")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("T")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Overrides Array.filter")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:173"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Filters the array with the callback")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])]),t._v(" "),r("td",[t._v("The filter function")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])]),t._v(" "),r("td",[t._v("The `this` object to apply the result to")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("T")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),t._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[t._v("#")]),t._v(" indexOf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("indexOf")]),t._v("(_other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Array.indexOf")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:97"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Finds the index of the value in the array")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" _other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),t._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[t._v("#")]),t._v(" map")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("map")]),t._v("<"),r("code",[t._v("U")]),t._v(">(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("U")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Overrides Array.map")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:182"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Maps the array with the callback")]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[t._v("#")]),t._v(" U")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])]),t._v(" "),r("td",[t._v("The mapping function")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])]),t._v(" "),r("td",[t._v("The `this` onject to apply the result to")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("U")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("T")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:115"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("T")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:122"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:129"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Array.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:138"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:151"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodevector"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodevector"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodevector","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeVector")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeVector")]),t._v("<"),r("code",[t._v("T")]),t._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("code",[t._v("T")]),t._v(">")],1),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("code",[t._v("any")]),t._v("> | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")],1),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("T")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"t-codec-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec-2","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("code",[t._v("T")]),t._v(">")],1)]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("code",[t._v("any")]),t._v("> | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("T")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("O")]),t._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("code",[t._v("O")]),t._v(">")],1),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("code",[t._v("O")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Vector.ts:48"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"o-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o-codec","aria-hidden":"true"}},[t._v("#")]),t._v(" O : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("code",[t._v("O")]),t._v(">")],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("code",[t._v("O")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/159.3879d14f.js b/docs/assets/js/159.3879d14f.js deleted file mode 100644 index 97b06949f6..0000000000 --- a/docs/assets/js/159.3879d14f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[159],{383:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ MagicNumber")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new MagicNumber")]),e._v("(value?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[e._v("MagicNumber")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MagicNumber.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/MagicNumber.ts:11"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[e._v("MagicNumber")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/16.40151e05.js b/docs/assets/js/16.40151e05.js deleted file mode 100644 index a20128bbdd..0000000000 --- a/docs/assets/js/16.40151e05.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{345:function(t,e,n){"use strict";n.r(e);var a=n(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"idtoindex"}})]),t._v(" "),n("h2",{attrs:{id:"idtoindex"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#idtoindex","aria-hidden":"true"}},[t._v("#")]),t._v(" idToIndex")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("idToIndex")]),t._v("(api: "),n("em",[n("code",[t._v("ApiInterface$Rx")])]),t._v("): "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/idToIndex.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("accounts/idToIndex.ts:13"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("api")]),t._v(" "),n("td",[n("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/160.2187440a.js b/docs/assets/js/160.2187440a.js deleted file mode 100644 index 94f28d9354..0000000000 --- a/docs/assets/js/160.2187440a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[160],{691:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Metadata")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The versioned runtime metadata as a decoded structure")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Metadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Metadata")]),t._v("(value?: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/Metadata.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/Metadata.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"asv0"}})]),t._v(" "),r("h2",{attrs:{id:"asv0"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asv0","aria-hidden":"true"}},[t._v("#")]),t._v(" asV0")]),t._v(" "),r("p",[r("strong",[t._v("get asV0")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html#asv0"}},[t._v("asV0")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:86"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the wrapped metadata as a V0 object")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"asv1"}})]),t._v(" "),r("h2",{attrs:{id:"asv1"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asv1","aria-hidden":"true"}},[t._v("#")]),t._v(" asV1")]),t._v(" "),r("p",[r("strong",[t._v("get asV1")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html#asv1"}},[t._v("asV1")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L103",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:103"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the wrapped values as a V1 object")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"magicnumber"}})]),t._v(" "),r("h2",{attrs:{id:"magicnumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#magicnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" magicNumber")]),t._v(" "),r("p",[r("strong",[t._v("get magicNumber")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[t._v("MagicNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html#magicnumber"}},[t._v("magicNumber")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:65"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(":")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[t._v("MagicNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"version"}})]),t._v(" "),r("h2",{attrs:{id:"version"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#version","aria-hidden":"true"}},[t._v("#")]),t._v(" version")]),t._v(" "),r("p",[r("strong",[t._v("get version")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html#version"}},[t._v("version")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:79"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the metadata version this structure represents")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getuniqtypes"}})]),t._v(" "),r("h2",{attrs:{id:"getuniqtypes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getuniqtypes","aria-hidden":"true"}},[t._v("#")]),t._v(" getUniqTypes")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getUniqTypes")]),t._v("(throwError: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html#getuniqtypes"}},[t._v("getUniqTypes")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html#getuniqtypes"}},[t._v("getUniqTypes")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L109",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:109"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("throwError")]),t._v(" "),r("td",[r("code",[t._v("boolean")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/161.680a3a2c.js b/docs/assets/js/161.680a3a2c.js deleted file mode 100644 index 6d2f2fb8a5..0000000000 --- a/docs/assets/js/161.680a3a2c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[161],{685:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MetadataVersioned")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The versioned runtime metadata as a decoded structure")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataVersioned")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataVersioned")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:53"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"asv0"}})]),t._v(" "),r("h2",{attrs:{id:"asv0"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asv0","aria-hidden":"true"}},[t._v("#")]),t._v(" asV0")]),t._v(" "),r("p",[r("strong",[t._v("get asV0")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:86"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the wrapped metadata as a V0 object")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"asv1"}})]),t._v(" "),r("h2",{attrs:{id:"asv1"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asv1","aria-hidden":"true"}},[t._v("#")]),t._v(" asV1")]),t._v(" "),r("p",[r("strong",[t._v("get asV1")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L103",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:103"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the wrapped values as a V1 object")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"magicnumber"}})]),t._v(" "),r("h2",{attrs:{id:"magicnumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#magicnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" magicNumber")]),t._v(" "),r("p",[r("strong",[t._v("get magicNumber")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[t._v("MagicNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:65"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(":")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[t._v("MagicNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"version"}})]),t._v(" "),r("h2",{attrs:{id:"version"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#version","aria-hidden":"true"}},[t._v("#")]),t._v(" version")]),t._v(" "),r("p",[r("strong",[t._v("get version")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:79"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the metadata version this structure represents")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getuniqtypes"}})]),t._v(" "),r("h2",{attrs:{id:"getuniqtypes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getuniqtypes","aria-hidden":"true"}},[t._v("#")]),t._v(" getUniqTypes")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getUniqTypes")]),t._v("(throwError: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html#getuniqtypes"}},[t._v("getUniqTypes")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L109",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/MetadataVersioned.ts:109"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("throwError")]),t._v(" "),r("td",[r("code",[t._v("boolean")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/162.0715e720.js b/docs/assets/js/162.0715e720.js deleted file mode 100644 index 03a3c2506d..0000000000 --- a/docs/assets/js/162.0715e720.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[162],{688:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ OuterDispatchCall")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new OuterDispatchCall")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Calls.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),t._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" index")]),t._v(" "),r("p",[r("strong",[t._v("get index")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Calls.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")]),t._v(" index for the call")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Calls.ts:29"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The name for the call")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"prefix"}})]),t._v(" "),r("h2",{attrs:{id:"prefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#prefix","aria-hidden":"true"}},[t._v("#")]),t._v(" prefix")]),t._v(" "),r("p",[r("strong",[t._v("get prefix")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Calls.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The call prefix (or section)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/163.13f3ff17.js b/docs/assets/js/163.13f3ff17.js deleted file mode 100644 index 5b497fa303..0000000000 --- a/docs/assets/js/163.13f3ff17.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[163],{682:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ OuterDispatchMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new OuterDispatchMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("OuterDispatchMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Calls.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("OuterDispatchMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"calls"}})]),t._v(" "),r("h2",{attrs:{id:"calls"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#calls","aria-hidden":"true"}},[t._v("#")]),t._v(" calls")]),t._v(" "),r("p",[r("strong",[t._v("get calls")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Calls.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The [[OuterDispathCall]] wrapped")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Calls.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The name for the dispatch")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/164.729efdb3.js b/docs/assets/js/164.729efdb3.js deleted file mode 100644 index 88a3872825..0000000000 --- a/docs/assets/js/164.729efdb3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[164],{679:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ EventMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new EventMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Events.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"arguments"}})]),t._v(" "),r("h2",{attrs:{id:"arguments"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#arguments","aria-hidden":"true"}},[t._v("#")]),t._v(" arguments")]),t._v(" "),r("p",[r("strong",[t._v("get arguments")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Events.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The arguments of "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html#type"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"documentation"}})]),t._v(" "),r("h2",{attrs:{id:"documentation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#documentation","aria-hidden":"true"}},[t._v("#")]),t._v(" documentation")]),t._v(" "),r("p",[r("strong",[t._v("get documentation")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Events.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" documentation")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Events.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The name for the event")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/165.d4599569.js b/docs/assets/js/165.d4599569.js deleted file mode 100644 index 95eab7bb65..0000000000 --- a/docs/assets/js/165.d4599569.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[165],{676:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ OuterEventMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new OuterEventMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("OuterEventMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Events.ts:65"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("OuterEventMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"events"}})]),t._v(" "),r("h2",{attrs:{id:"events"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#events","aria-hidden":"true"}},[t._v("#")]),t._v(" events")]),t._v(" "),r("p",[r("strong",[t._v("get events")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Events.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Events.ts:83"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The name of the event")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/166.1d7b1fd8.js b/docs/assets/js/166.1d7b1fd8.js deleted file mode 100644 index a492d53f8a..0000000000 --- a/docs/assets/js/166.1d7b1fd8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[166],{380:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ OuterEventMetadataEvent")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new OuterEventMetadataEvent")]),e._v("(value?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[e._v("OuterEventMetadataEvent")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Events.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[e._v("OuterEventMetadataEvent")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"events"}})]),e._v(" "),r("h2",{attrs:{id:"events"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#events","aria-hidden":"true"}},[e._v("#")]),e._v(" events")]),e._v(" "),r("p",[r("strong",[e._v("get events")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Events.ts:53"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),e._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[e._v("#")]),e._v(" name")]),e._v(" "),r("p",[r("strong",[e._v("get name")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[e._v("Text")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Events.ts:60"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The name of the section")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[e._v("Text")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/167.67c476d6.js b/docs/assets/js/167.67c476d6.js deleted file mode 100644 index ac49aa4b24..0000000000 --- a/docs/assets/js/167.67c476d6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[167],{673:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MetadataV0")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The runtime metadata as a decoded structure")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataV0")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataV0")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Metadata.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"calls"}})]),t._v(" "),r("h2",{attrs:{id:"calls"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#calls","aria-hidden":"true"}},[t._v("#")]),t._v(" calls")]),t._v(" "),r("p",[r("strong",[t._v("get calls")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Metadata.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Wrapped "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"events"}})]),t._v(" "),r("h2",{attrs:{id:"events"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#events","aria-hidden":"true"}},[t._v("#")]),t._v(" events")]),t._v(" "),r("p",[r("strong",[t._v("get events")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Metadata.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Wrapped "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"modules"}})]),t._v(" "),r("h2",{attrs:{id:"modules"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#modules","aria-hidden":"true"}},[t._v("#")]),t._v(" modules")]),t._v(" "),r("p",[r("strong",[t._v("get modules")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Metadata.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Wrapped "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getuniqtypes"}})]),t._v(" "),r("h2",{attrs:{id:"getuniqtypes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getuniqtypes","aria-hidden":"true"}},[t._v("#")]),t._v(" getUniqTypes")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getUniqTypes")]),t._v("(throwError: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html#getuniqtypes"}},[t._v("getUniqTypes")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L109",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Metadata.ts:109"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Helper to retrieve a list of all type that are found, sorted and de-deuplicated")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("throwError")]),t._v(" "),r("td",[r("code",[t._v("boolean")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodemetadata"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodemetadata"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeMetadata")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeMetadata")]),t._v("(value: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("object")])]),t._v("): "),r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Metadata.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("object")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/168.1a2681d6.js b/docs/assets/js/168.1a2681d6.js deleted file mode 100644 index fff82d5f8a..0000000000 --- a/docs/assets/js/168.1a2681d6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[168],{670:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ CallMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new CallMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:79"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"functions"}})]),t._v(" "),r("h2",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" functions")]),t._v(" "),r("p",[r("strong",[t._v("get functions")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:90"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The functions available as "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:97"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The section name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/169.6f182405.js b/docs/assets/js/169.6f182405.js deleted file mode 100644 index 03e09c8660..0000000000 --- a/docs/assets/js/169.6f182405.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[169],{667:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ FunctionArgumentMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new FunctionArgumentMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The argument name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type-1"}})]),t._v(" "),r("h2",{attrs:{id:"type-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-2","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("get type")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html#type"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/17.0cadbbe1.js b/docs/assets/js/17.0cadbbe1.js deleted file mode 100644 index be5bf5d550..0000000000 --- a/docs/assets/js/17.0cadbbe1.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{346:function(e,t,a){"use strict";a.r(t);var n=a(46),s=Object(n.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"accountindexes"}})]),e._v(" "),a("h2",{attrs:{id:"accountindexes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accountindexes","aria-hidden":"true"}},[e._v("#")]),e._v(" AccountIndexes")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ AccountIndexes")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/indexes.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("accounts/indexes.ts:13"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),a("p",[a("a",{attrs:{id:"indexes"}})]),e._v(" "),a("h2",{attrs:{id:"indexes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#indexes","aria-hidden":"true"}},[e._v("#")]),e._v(" indexes")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("indexes")]),e._v("(api: "),a("em",[a("code",[e._v("ApiInterface$Rx")])]),e._v("): "),a("code",[e._v("(Anonymous function)")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/indexes.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("accounts/indexes.ts:15"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("api")]),e._v(" "),a("td",[a("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("(Anonymous function)")])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/170.e5a9cf81.js b/docs/assets/js/170.e5a9cf81.js deleted file mode 100644 index 50704c801f..0000000000 --- a/docs/assets/js/170.e5a9cf81.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[170],{664:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ FunctionMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new FunctionMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"arguments"}})]),t._v(" "),r("h2",{attrs:{id:"arguments"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#arguments","aria-hidden":"true"}},[t._v("#")]),t._v(" arguments")]),t._v(" "),r("p",[r("strong",[t._v("get arguments")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:53"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")]),t._v(" for arguments")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"documentation"}})]),t._v(" "),r("h2",{attrs:{id:"documentation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#documentation","aria-hidden":"true"}},[t._v("#")]),t._v(" documentation")]),t._v(" "),r("p",[r("strong",[t._v("get documentation")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" documentation")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"id"}})]),t._v(" "),r("h2",{attrs:{id:"id"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#id","aria-hidden":"true"}},[t._v("#")]),t._v(" id")]),t._v(" "),r("p",[r("strong",[t._v("get id")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("code",[t._v("[sectionIndex, methodIndex]")]),t._v(" call id")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The call name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/171.0fa7c9d5.js b/docs/assets/js/171.0fa7c9d5.js deleted file mode 100644 index 31f62744f1..0000000000 --- a/docs/assets/js/171.0fa7c9d5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[171],{661:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MapType")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MapType")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L138",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:138"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"key"}})]),t._v(" "),r("h2",{attrs:{id:"key"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[t._v("#")]),t._v(" key")]),t._v(" "),r("p",[r("strong",[t._v("get key")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:149"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The mapped key as "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html#type"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),t._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[t._v("#")]),t._v(" value")]),t._v(" "),r("p",[r("strong",[t._v("get value")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:156"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The mapped value as "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html#type"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/172.ea468e02.js b/docs/assets/js/172.ea468e02.js deleted file mode 100644 index 3a01a14357..0000000000 --- a/docs/assets/js/172.ea468e02.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[172],{658:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ ModuleMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new ModuleMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:102"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"call"}})]),t._v(" "),r("h2",{attrs:{id:"call"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#call","aria-hidden":"true"}},[t._v("#")]),t._v(" call")]),t._v(" "),r("p",[r("strong",[t._v("get call")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L113",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:113"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The calls as "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L120",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:120"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/173.0b544598.js b/docs/assets/js/173.0b544598.js deleted file mode 100644 index 9a5ff45b69..0000000000 --- a/docs/assets/js/173.0b544598.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[173],{655:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ RuntimeModuleMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new RuntimeModuleMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L281",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:281"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"module"}})]),t._v(" "),r("h2",{attrs:{id:"module"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#module","aria-hidden":"true"}},[t._v("#")]),t._v(" module")]),t._v(" "),r("p",[r("strong",[t._v("get module")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L293",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:293"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"prefix"}})]),t._v(" "),r("h2",{attrs:{id:"prefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#prefix","aria-hidden":"true"}},[t._v("#")]),t._v(" prefix")]),t._v(" "),r("p",[r("strong",[t._v("get prefix")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L300",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:300"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The prefix")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"storage"}})]),t._v(" "),r("h2",{attrs:{id:"storage"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#storage","aria-hidden":"true"}},[t._v("#")]),t._v(" storage")]),t._v(" "),r("p",[r("strong",[t._v("get storage")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L307",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:307"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The optional "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/174.9ab8554e.js b/docs/assets/js/174.9ab8554e.js deleted file mode 100644 index 3d0854645f..0000000000 --- a/docs/assets/js/174.9ab8554e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[174],{652:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ StorageFunctionMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new StorageFunctionMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("StorageFunctionMetadataValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L211",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:211"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("StorageFunctionMetadataValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"default"}})]),t._v(" "),r("h2",{attrs:{id:"default"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#default","aria-hidden":"true"}},[t._v("#")]),t._v(" default")]),t._v(" "),r("p",[r("strong",[t._v("get default")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L225",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:225"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The default value of the storage function")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"documentation"}})]),t._v(" "),r("h2",{attrs:{id:"documentation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#documentation","aria-hidden":"true"}},[t._v("#")]),t._v(" documentation")]),t._v(" "),r("p",[r("strong",[t._v("get documentation")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L232",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:232"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" documentation")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"modifier"}})]),t._v(" "),r("h2",{attrs:{id:"modifier"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#modifier","aria-hidden":"true"}},[t._v("#")]),t._v(" modifier")]),t._v(" "),r("p",[r("strong",[t._v("get modifier")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[t._v("StorageFunctionModifier")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L246",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:246"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The modifier")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[t._v("StorageFunctionModifier")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L239",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:239"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The key name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type-1"}})]),t._v(" "),r("h2",{attrs:{id:"type-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-2","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("get type")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[t._v("StorageFunctionType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L253",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:253"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[t._v("StorageFunctionType")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[t._v("StorageFunctionType")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/175.9c2273db.js b/docs/assets/js/175.9c2273db.js deleted file mode 100644 index 3a3144d05b..0000000000 --- a/docs/assets/js/175.9c2273db.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[175],{539:function(e,t,r){"use strict";r.r(t);var s=r(46),o=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ StorageFunctionModifier")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new StorageFunctionModifier")]),e._v("(value?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[e._v("StorageFunctionModifier")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Modules.ts:125"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[e._v("StorageFunctionModifier")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:64"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:71"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value (always false)")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isoptional"}})]),e._v(" "),r("h2",{attrs:{id:"isoptional"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isoptional","aria-hidden":"true"}},[e._v("#")]),e._v(" isOptional")]),e._v(" "),r("p",[r("strong",[e._v("get isOptional")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L133",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Modules.ts:133"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": "),r("code",[e._v("true")]),e._v(" if the storage entry is optional")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:78"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:112"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:120"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeenum"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodeenum"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeenum","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeEnum")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeEnum")]),e._v("(def: "),r("em",[r("code",[e._v("EnumDef")])]),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#decodeenum"}},[e._v("decodeEnum")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:47"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("def")]),e._v(" "),r("td",[r("code",[e._v("EnumDef")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/176.c8ca0f49.js b/docs/assets/js/176.c8ca0f49.js deleted file mode 100644 index a37b430220..0000000000 --- a/docs/assets/js/176.c8ca0f49.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[176],{649:function(e,t,r){"use strict";r.r(t);var s=r(46),_=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("PlainType")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[e._v("MapType")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("↳ StorageFunctionType")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new StorageFunctionType")]),e._v("(value?: "),r("em",[r("code",[e._v("any")])]),e._v(", index?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[e._v("StorageFunctionType")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Modules.ts:164"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("any")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[e._v("StorageFunctionType")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"asmap"}})]),e._v(" "),r("h2",{attrs:{id:"asmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asmap","aria-hidden":"true"}},[e._v("#")]),e._v(" asMap")]),e._v(" "),r("p",[r("strong",[e._v("get asMap")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[e._v("MapType")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L182",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Modules.ts:182"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value as a mapped value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[e._v("MapType")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"astype"}})]),e._v(" "),r("h2",{attrs:{id:"astype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#astype","aria-hidden":"true"}},[e._v("#")]),e._v(" asType")]),e._v(" "),r("p",[r("strong",[e._v("get asType")]),e._v("(): "),r("code",[e._v("PlainType")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L189",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Modules.ts:189"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value as a "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[e._v("Type")]),e._v(" value")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("PlainType")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[e._v("index")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The index of the metadata value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:128"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"ismap"}})]),e._v(" "),r("h2",{attrs:{id:"ismap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#ismap","aria-hidden":"true"}},[e._v("#")]),e._v(" isMap")]),e._v(" "),r("p",[r("strong",[e._v("get isMap")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L175",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Modules.ts:175"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": "),r("code",[e._v("true")]),e._v(" if the storage entry is a map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),e._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[e._v("#")]),e._v(" isNone")]),e._v(" "),r("p",[r("strong",[e._v("get isNone")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[e._v("isNone")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:135"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnull"}})]),e._v(" "),r("h2",{attrs:{id:"isnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[e._v("#")]),e._v(" isNull")]),e._v(" "),r("p",[r("strong",[e._v("get isNull")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[e._v("isNull")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:142"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type (deprecated, use isNone)")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" type")]),e._v(" "),r("p",[r("strong",[e._v("get type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[e._v("type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The name of the type this enum value represents")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[e._v("value")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:156"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value of the enum")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:163"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:183"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:192"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v0/Modules.ts:196"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:209"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[e._v("ConstructorDef")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/177.5fa49e5c.js b/docs/assets/js/177.5fa49e5c.js deleted file mode 100644 index 6b5adede2a..0000000000 --- a/docs/assets/js/177.5fa49e5c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[177],{646:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ StorageMetadata")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new StorageMetadata")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L258",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:258"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"functions"}})]),t._v(" "),r("h2",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" functions")]),t._v(" "),r("p",[r("strong",[t._v("get functions")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L269",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:269"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")]),t._v(" for the section")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"prefix"}})]),t._v(" "),r("h2",{attrs:{id:"prefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#prefix","aria-hidden":"true"}},[t._v("#")]),t._v(" prefix")]),t._v(" "),r("p",[r("strong",[t._v("get prefix")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L276",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v0/Modules.ts:276"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The section prefix")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/178.85753470.js b/docs/assets/js/178.85753470.js deleted file mode 100644 index 265a84d512..0000000000 --- a/docs/assets/js/178.85753470.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[178],{643:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MetadataCall")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The definition of a call")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataCall")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataCall")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Calls.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"args"}})]),t._v(" "),r("h2",{attrs:{id:"args"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#args","aria-hidden":"true"}},[t._v("#")]),t._v(" args")]),t._v(" "),r("p",[r("strong",[t._v("get args")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Calls.ts:53"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")]),t._v(" for arguments")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"docs"}})]),t._v(" "),r("h2",{attrs:{id:"docs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#docs","aria-hidden":"true"}},[t._v("#")]),t._v(" docs")]),t._v(" "),r("p",[r("strong",[t._v("get docs")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Calls.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" documentation")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Calls.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The call name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/179.33c19c3b.js b/docs/assets/js/179.33c19c3b.js deleted file mode 100644 index b27a77e656..0000000000 --- a/docs/assets/js/179.33c19c3b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[179],{640:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataCallArg")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataCallArg")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Calls.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Calls.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The argument name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type-1"}})]),t._v(" "),r("h2",{attrs:{id:"type-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-2","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("get type")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Calls.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html#type"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/18.714d6145.js b/docs/assets/js/18.714d6145.js deleted file mode 100644 index c54edaf15e..0000000000 --- a/docs/assets/js/18.714d6145.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{348:function(t,e,n){"use strict";n.r(e);var a=n(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"indextoid"}})]),t._v(" "),n("h2",{attrs:{id:"indextoid"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#indextoid","aria-hidden":"true"}},[t._v("#")]),t._v(" indexToId")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("indexToId")]),t._v("(api: "),n("em",[n("code",[t._v("ApiInterface$Rx")])]),t._v("): "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/accounts/indexToId.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("accounts/indexToId.ts:13"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("api")]),t._v(" "),n("td",[n("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/180.f41fbd45.js b/docs/assets/js/180.f41fbd45.js deleted file mode 100644 index 76fcf4d770..0000000000 --- a/docs/assets/js/180.f41fbd45.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[180],{637:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MetadataEvent")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The definition of an event")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataEvent")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataEvent")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Events.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"args"}})]),t._v(" "),r("h2",{attrs:{id:"args"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#args","aria-hidden":"true"}},[t._v("#")]),t._v(" args")]),t._v(" "),r("p",[r("strong",[t._v("get args")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Events.ts:27"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html#type"}},[t._v("Type")]),t._v(" for args")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"docs"}})]),t._v(" "),r("h2",{attrs:{id:"docs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#docs","aria-hidden":"true"}},[t._v("#")]),t._v(" docs")]),t._v(" "),r("p",[r("strong",[t._v("get docs")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Events.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" documentation")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Events.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The call name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/181.3cbec004.js b/docs/assets/js/181.3cbec004.js deleted file mode 100644 index dd6a55b6eb..0000000000 --- a/docs/assets/js/181.3cbec004.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[181],{634:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MetadataModule")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The definition of a module in the system")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataModule")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataModule")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"calls"}})]),t._v(" "),r("h2",{attrs:{id:"calls"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#calls","aria-hidden":"true"}},[t._v("#")]),t._v(" calls")]),t._v(" "),r("p",[r("strong",[t._v("get calls")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the module calls")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")]),t._v(">>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"events"}})]),t._v(" "),r("h2",{attrs:{id:"events"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#events","aria-hidden":"true"}},[t._v("#")]),t._v(" events")]),t._v(" "),r("p",[r("strong",[t._v("get events")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:43"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the module events")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")]),t._v(">>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:50"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the module name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"prefix"}})]),t._v(" "),r("h2",{attrs:{id:"prefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#prefix","aria-hidden":"true"}},[t._v("#")]),t._v(" prefix")]),t._v(" "),r("p",[r("strong",[t._v("get prefix")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L57",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:57"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the module prefix")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"storage"}})]),t._v(" "),r("h2",{attrs:{id:"storage"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#storage","aria-hidden":"true"}},[t._v("#")]),t._v(" storage")]),t._v(" "),r("p",[r("strong",[t._v("get storage")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:64"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the associated module storage")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")]),t._v(">>")],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/182.be73a590.js b/docs/assets/js/182.be73a590.js deleted file mode 100644 index b0ef39e982..0000000000 --- a/docs/assets/js/182.be73a590.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[182],{631:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MetadataV1")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The runtime metadata as a decoded structure")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataV1")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataV1")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"modules"}})]),t._v(" "),r("h2",{attrs:{id:"modules"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#modules","aria-hidden":"true"}},[t._v("#")]),t._v(" modules")]),t._v(" "),r("p",[r("strong",[t._v("get modules")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:84"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The associated modules for this structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getuniqtypes"}})]),t._v(" "),r("h2",{attrs:{id:"getuniqtypes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getuniqtypes","aria-hidden":"true"}},[t._v("#")]),t._v(" getUniqTypes")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getUniqTypes")]),t._v("(throwError: "),r("em",[r("code",[t._v("boolean")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html#getuniqtypes"}},[t._v("getUniqTypes")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Metadata.ts:123"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Helper to retrieve a list of all type that are found, sorted and de-deuplicated")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("throwError")]),t._v(" "),r("td",[r("code",[t._v("boolean")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/183.97ea8694.js b/docs/assets/js/183.97ea8694.js deleted file mode 100644 index 8c7a608e6d..0000000000 --- a/docs/assets/js/183.97ea8694.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[183],{540:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Default")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/184.f5c4d39a.js b/docs/assets/js/184.f5c4d39a.js deleted file mode 100644 index fb3f62dbb3..0000000000 --- a/docs/assets/js/184.f5c4d39a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[184],{628:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MapType")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MapType")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"key"}})]),t._v(" "),r("h2",{attrs:{id:"key"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[t._v("#")]),t._v(" key")]),t._v(" "),r("p",[r("strong",[t._v("get key")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:48"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The mapped key as "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html#type"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),t._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[t._v("#")]),t._v(" value")]),t._v(" "),r("p",[r("strong",[t._v("get value")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:55"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The mapped value as "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html#type"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/185.63a044a8.js b/docs/assets/js/185.63a044a8.js deleted file mode 100644 index c7e36ec5a0..0000000000 --- a/docs/assets/js/185.63a044a8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[185],{625:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MetadataModule")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The definition of a storage function")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MetadataStorage")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MetadataStorage")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:107"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"docs"}})]),t._v(" "),r("h2",{attrs:{id:"docs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#docs","aria-hidden":"true"}},[t._v("#")]),t._v(" docs")]),t._v(" "),r("p",[r("strong",[t._v("get docs")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:121"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" documentation")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"fallback"}})]),t._v(" "),r("h2",{attrs:{id:"fallback"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fallback","aria-hidden":"true"}},[t._v("#")]),t._v(" fallback")]),t._v(" "),r("p",[r("strong",[t._v("get fallback")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:128"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")]),t._v(" fallback default")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"modifier"}})]),t._v(" "),r("h2",{attrs:{id:"modifier"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#modifier","aria-hidden":"true"}},[t._v("#")]),t._v(" modifier")]),t._v(" "),r("p",[r("strong",[t._v("get modifier")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[t._v("MetadataStorageModifier")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:135"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The [[MetadataArgument]] for arguments")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[t._v("MetadataStorageModifier")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"name"}})]),t._v(" "),r("h2",{attrs:{id:"name"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#name","aria-hidden":"true"}},[t._v("#")]),t._v(" name")]),t._v(" "),r("p",[r("strong",[t._v("get name")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:142"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The call name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type-1"}})]),t._v(" "),r("h2",{attrs:{id:"type-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-2","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("get type")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[t._v("MetadataStorageType")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/Storage.ts:149"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[t._v("MetadataStorageType")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[t._v("MetadataStorageType")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/186.edf6b277.js b/docs/assets/js/186.edf6b277.js deleted file mode 100644 index 586d3d7c96..0000000000 --- a/docs/assets/js/186.edf6b277.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[186],{542:function(e,t,r){"use strict";r.r(t);var s=r(46),_=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.optional.html"}},[e._v("Optional")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.default.html"}},[e._v("Default")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("↳ MetadataStorageModifier")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new MetadataStorageModifier")]),e._v("(value?: "),r("em",[r("code",[e._v("any")])]),e._v(", index?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[e._v("MetadataStorageModifier")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:17"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("any")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[e._v("MetadataStorageModifier")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[e._v("index")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The index of the metadata value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:128"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),e._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[e._v("#")]),e._v(" isNone")]),e._v(" "),r("p",[r("strong",[e._v("get isNone")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[e._v("isNone")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:135"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnull"}})]),e._v(" "),r("h2",{attrs:{id:"isnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[e._v("#")]),e._v(" isNull")]),e._v(" "),r("p",[r("strong",[e._v("get isNull")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[e._v("isNull")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:142"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type (deprecated, use isNone)")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isoptional"}})]),e._v(" "),r("h2",{attrs:{id:"isoptional"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isoptional","aria-hidden":"true"}},[e._v("#")]),e._v(" isOptional")]),e._v(" "),r("p",[r("strong",[e._v("get isOptional")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:28"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": "),r("code",[e._v("true")]),e._v(" if the storage entry is optional")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" type")]),e._v(" "),r("p",[r("strong",[e._v("get type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[e._v("type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The name of the type this enum value represents")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[e._v("value")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:156"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value of the enum")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:163"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:192"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:199"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:209"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[e._v("ConstructorDef")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/187.5c94433e.js b/docs/assets/js/187.5c94433e.js deleted file mode 100644 index 0d1a0dd70f..0000000000 --- a/docs/assets/js/187.5c94433e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[187],{622:function(e,t,r){"use strict";r.r(t);var s=r(46),a=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[e._v("PlainType")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[e._v("MapType")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("↳ MetadataStorageType")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new MetadataStorageType")]),e._v("(value?: "),r("em",[r("code",[e._v("any")])]),e._v(", index?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[e._v("MetadataStorageType")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:63"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("any")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[e._v("MetadataStorageType")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"asmap"}})]),e._v(" "),r("h2",{attrs:{id:"asmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asmap","aria-hidden":"true"}},[e._v("#")]),e._v(" asMap")]),e._v(" "),r("p",[r("strong",[e._v("get asMap")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[e._v("MapType")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:81"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value as a mapped value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[e._v("MapType")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"astype"}})]),e._v(" "),r("h2",{attrs:{id:"astype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#astype","aria-hidden":"true"}},[e._v("#")]),e._v(" asType")]),e._v(" "),r("p",[r("strong",[e._v("get asType")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[e._v("PlainType")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:88"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value as a "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[e._v("Type")]),e._v(" value")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[e._v("PlainType")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[e._v("index")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The index of the metadata value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:128"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"ismap"}})]),e._v(" "),r("h2",{attrs:{id:"ismap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#ismap","aria-hidden":"true"}},[e._v("#")]),e._v(" isMap")]),e._v(" "),r("p",[r("strong",[e._v("get isMap")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:74"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": "),r("code",[e._v("true")]),e._v(" if the storage entry is a map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),e._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[e._v("#")]),e._v(" isNone")]),e._v(" "),r("p",[r("strong",[e._v("get isNone")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[e._v("isNone")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:135"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnull"}})]),e._v(" "),r("h2",{attrs:{id:"isnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[e._v("#")]),e._v(" isNull")]),e._v(" "),r("p",[r("strong",[e._v("get isNull")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[e._v("isNull")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:142"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type (deprecated, use isNone)")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" type")]),e._v(" "),r("p",[r("strong",[e._v("get type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[e._v("type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The name of the type this enum value represents")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[e._v("value")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:156"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value of the enum")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:163"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:183"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:192"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L95",target:"_blank",rel:"noopener noreferrer"}},[e._v("Metadata/v1/Storage.ts:95"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:209"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[e._v("ConstructorDef")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/188.7c0aa44e.js b/docs/assets/js/188.7c0aa44e.js deleted file mode 100644 index 88bfb98fb4..0000000000 --- a/docs/assets/js/188.7c0aa44e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[188],{543:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Optional")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/189.21bc2a5f.js b/docs/assets/js/189.21bc2a5f.js deleted file mode 100644 index 878e52f088..0000000000 --- a/docs/assets/js/189.21bc2a5f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[189],{476:function(t,e,r){"use strict";r.r(e);var _=r(46),v=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ PlainType")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[index: "),r("code",[t._v("number")]),t._v("]: "),r("code",[t._v("string")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new PlainType")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[t._v("PlainType")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Type.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")])],1),t._v(" "),r("td",[t._v('""')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[t._v("PlainType")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Type.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),t._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[t._v("#")]),t._v(" length")]),t._v(" "),r("p",[r("strong",[t._v("get length")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#length"}},[t._v("length")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides String.length")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:235")])]),t._v(" "),r("p",[t._v("Iterator")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"anchor"}})]),t._v(" "),r("h2",{attrs:{id:"anchor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#anchor","aria-hidden":"true"}},[t._v("#")]),t._v(" anchor")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("anchor")]),t._v("(name: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.anchor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:454")])]),t._v(" "),r("p",[t._v("Returns an HTML anchor element and sets the name attribute to the text value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td")])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"big"}})]),t._v(" "),r("h2",{attrs:{id:"big"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#big","aria-hidden":"true"}},[t._v("#")]),t._v(" big")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("big")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.big")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:457")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"blink"}})]),t._v(" "),r("h2",{attrs:{id:"blink"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#blink","aria-hidden":"true"}},[t._v("#")]),t._v(" blink")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("blink")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.blink")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:460")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"bold"}})]),t._v(" "),r("h2",{attrs:{id:"bold"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bold","aria-hidden":"true"}},[t._v("#")]),t._v(" bold")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("bold")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.bold")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:463")])]),t._v(" "),r("p",[t._v("Returns a "),r("strong",[t._v("HTML element")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"charat"}})]),t._v(" "),r("h2",{attrs:{id:"charat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#charat","aria-hidden":"true"}},[t._v("#")]),t._v(" charAt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("charAt")]),t._v("(pos: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.charAt")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:402")])]),t._v(" "),r("p",[t._v("Returns the character at the specified index.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("pos")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The zero-based index of the desired character.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"charcodeat"}})]),t._v(" "),r("h2",{attrs:{id:"charcodeat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#charcodeat","aria-hidden":"true"}},[t._v("#")]),t._v(" charCodeAt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("charCodeAt")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.charCodeAt")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:408")])]),t._v(" "),r("p",[t._v("Returns the Unicode value of the character at the specified location.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"codepointat"}})]),t._v(" "),r("h2",{attrs:{id:"codepointat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codepointat","aria-hidden":"true"}},[t._v("#")]),t._v(" codePointAt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("codePointAt")]),t._v("(pos: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.codePointAt")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:402")])]),t._v(" "),r("p",[t._v("Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("pos")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),t._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[t._v("#")]),t._v(" concat")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("concat")]),t._v("(...strings: "),r("em",[r("code",[t._v("string")]),t._v("[]")]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.concat")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:414")])]),t._v(" "),r("p",[t._v("Returns a string that contains the concatenation of two or more strings.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Rest")]),t._v(" strings")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v("[]")]),t._v(" "),r("td",[t._v("The strings to append to the end of the string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"endswith"}})]),t._v(" "),r("h2",{attrs:{id:"endswith"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#endswith","aria-hidden":"true"}},[t._v("#")]),t._v(" endsWith")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("endsWith")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", endPosition?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.endsWith")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:418")])]),t._v(" "),r("p",[t._v("Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" endPosition")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"fixed"}})]),t._v(" "),r("h2",{attrs:{id:"fixed"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fixed","aria-hidden":"true"}},[t._v("#")]),t._v(" fixed")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fixed")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fixed")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:466")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"fontcolor"}})]),t._v(" "),r("h2",{attrs:{id:"fontcolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fontcolor","aria-hidden":"true"}},[t._v("#")]),t._v(" fontcolor")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fontcolor")]),t._v("(color: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fontcolor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:469")])]),t._v(" "),r("p",[t._v("Returns a HTML element and sets the color attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("color")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"fontsize"}})]),t._v(" "),r("h2",{attrs:{id:"fontsize"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fontsize","aria-hidden":"true"}},[t._v("#")]),t._v(" fontsize")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fontsize")]),t._v("(size: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fontsize")]),t._v("(size: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fontsize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:472")])]),t._v(" "),r("p",[t._v("Returns a HTML element and sets the size attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("size")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fontsize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:475")])]),t._v(" "),r("p",[t._v("Returns a HTML element and sets the size attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("size")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),t._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[t._v("#")]),t._v(" includes")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("includes")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.includes")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:411")])]),t._v(" "),r("p",[t._v("Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("search string")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("If position is undefined, 0 is assumed, so as to search all of the String.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),t._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[t._v("#")]),t._v(" indexOf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("indexOf")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.indexOf")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:421")])]),t._v(" "),r("p",[t._v("Returns the position of the first occurrence of a substring.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("The substring to search for in the string")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"italics"}})]),t._v(" "),r("h2",{attrs:{id:"italics"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#italics","aria-hidden":"true"}},[t._v("#")]),t._v(" italics")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("italics")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.italics")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:478")])]),t._v(" "),r("p",[t._v("Returns an "),r("em",[t._v("HTML element")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),t._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[t._v("#")]),t._v(" lastIndexOf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("lastIndexOf")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.lastIndexOf")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:428")])]),t._v(" "),r("p",[t._v("Returns the last occurrence of a substring in the string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("The substring to search for.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index at which to begin searching. If omitted, the search begins at the end of the string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"link"}})]),t._v(" "),r("h2",{attrs:{id:"link"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#link","aria-hidden":"true"}},[t._v("#")]),t._v(" link")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("link")]),t._v("(url: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.link")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:481")])]),t._v(" "),r("p",[t._v("Returns an HTML element and sets the href attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("url")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"localecompare"}})]),t._v(" "),r("h2",{attrs:{id:"localecompare"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#localecompare","aria-hidden":"true"}},[t._v("#")]),t._v(" localeCompare")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("localeCompare")]),t._v("(that: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.localeCompare")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:434")])]),t._v(" "),r("p",[t._v("Determines whether two strings are equivalent in the current locale.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("that")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("String to compare to target string")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"match"}})]),t._v(" "),r("h2",{attrs:{id:"match"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#match","aria-hidden":"true"}},[t._v("#")]),t._v(" match")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("match")]),t._v("(regexp: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v("): "),r("code",[t._v("RegExpMatchArray")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.match")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.match")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:440")])]),t._v(" "),r("p",[t._v("Matches a string with a regular expression, and returns an array containing the results of that search.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("regexp")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A variable name or string literal containing the regular expression pattern and flags.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("RegExpMatchArray")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"normalize"}})]),t._v(" "),r("h2",{attrs:{id:"normalize"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#normalize","aria-hidden":"true"}},[t._v("#")]),t._v(" normalize")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("normalize")]),t._v("(form: "),r("em",[t._v('"NFC" | "NFD" | "NFKC" | "NFKD"')]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("normalize")]),t._v("(form?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.normalize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:426")])]),t._v(" "),r("p",[t._v("Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("form")]),t._v(" "),r("td",[t._v('"NFC" | "NFD" | "NFKC" | "NFKD"')]),t._v(" "),r("td",[t._v('Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.normalize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:434")])]),t._v(" "),r("p",[t._v("Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" form")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(" "),r("td",[t._v('Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"padend"}})]),t._v(" "),r("h2",{attrs:{id:"padend"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#padend","aria-hidden":"true"}},[t._v("#")]),t._v(" padEnd")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("padEnd")]),t._v("(maxLength: "),r("em",[r("code",[t._v("number")])]),t._v(", fillString?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.padEnd")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:46")])]),t._v(" "),r("p",[t._v("Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("maxLength")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" fillString")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(" "),r("td",[t._v('The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"padstart"}})]),t._v(" "),r("h2",{attrs:{id:"padstart"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#padstart","aria-hidden":"true"}},[t._v("#")]),t._v(" padStart")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("padStart")]),t._v("(maxLength: "),r("em",[r("code",[t._v("number")])]),t._v(", fillString?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.padStart")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:33")])]),t._v(" "),r("p",[t._v("Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("maxLength")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" fillString")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(" "),r("td",[t._v('The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"repeat"}})]),t._v(" "),r("h2",{attrs:{id:"repeat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#repeat","aria-hidden":"true"}},[t._v("#")]),t._v(" repeat")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("repeat")]),t._v("(count: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.repeat")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:441")])]),t._v(" "),r("p",[t._v("Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("count")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("number of copies to append")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"replace"}})]),t._v(" "),r("h2",{attrs:{id:"replace"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#replace","aria-hidden":"true"}},[t._v("#")]),t._v(" replace")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("replace")]),t._v("(searchValue: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(", replaceValue: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("replace")]),t._v("(searchValue: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(", replacer: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:447")])]),t._v(" "),r("p",[t._v("Replaces text in a string, using a regular expression or search string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchValue")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A string to search for.")])]),t._v(" "),r("tr",[r("td",[t._v("replaceValue")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("A string containing the text to replace for every successful match of searchValue in this string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:454")])]),t._v(" "),r("p",[t._v("Replaces text in a string, using a regular expression or search string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchValue")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A string to search for.")])]),t._v(" "),r("tr",[r("td",[t._v("replacer")]),t._v(" "),r("td",[r("code",[t._v("function")])]),t._v(" "),r("td",[t._v("A function that returns the replacement text.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"search"}})]),t._v(" "),r("h2",{attrs:{id:"search"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#search","aria-hidden":"true"}},[t._v("#")]),t._v(" search")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("search")]),t._v("(regexp: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.search")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.search")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:460")])]),t._v(" "),r("p",[t._v("Finds the first substring match in a regular expression search.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("regexp")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("The regular expression pattern and applicable flags.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),t._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[t._v("#")]),t._v(" slice")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("slice")]),t._v("(start?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(", end?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.slice")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:468")])]),t._v(" "),r("p",[t._v("Returns a section of a string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" start")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index to the beginning of the specified portion of stringObj.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" end")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"small"}})]),t._v(" "),r("h2",{attrs:{id:"small"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#small","aria-hidden":"true"}},[t._v("#")]),t._v(" small")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("small")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.small")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:484")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"split"}})]),t._v(" "),r("h2",{attrs:{id:"split"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#split","aria-hidden":"true"}},[t._v("#")]),t._v(" split")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("split")]),t._v("(separator: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(", limit?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")]),t._v("[]")]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.split")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.split")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:475")])]),t._v(" "),r("p",[t._v("Split a string into substrings using the specified separator and return them as an array.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("separator")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" limit")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("A value used to limit the number of elements returned in the array.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")]),t._v("[]")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"startswith"}})]),t._v(" "),r("h2",{attrs:{id:"startswith"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#startswith","aria-hidden":"true"}},[t._v("#")]),t._v(" startsWith")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("startsWith")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.startsWith")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:448")])]),t._v(" "),r("p",[t._v("Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"strike"}})]),t._v(" "),r("h2",{attrs:{id:"strike"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#strike","aria-hidden":"true"}},[t._v("#")]),t._v(" strike")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("strike")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.strike")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:487")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sub"}})]),t._v(" "),r("h2",{attrs:{id:"sub"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[t._v("#")]),t._v(" sub")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sub")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.sub")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:490")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"substr"}})]),t._v(" "),r("h2",{attrs:{id:"substr"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#substr","aria-hidden":"true"}},[t._v("#")]),t._v(" substr")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("substr")]),t._v("(from: "),r("em",[r("code",[t._v("number")])]),t._v(", length?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.substr")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:509")])]),t._v(" "),r("p",[t._v("Gets a substring beginning at the specified location and having the specified length.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("from")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The starting position of the desired substring. The index of the first character in the string is zero.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" length")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The number of characters to include in the returned substring.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"substring"}})]),t._v(" "),r("h2",{attrs:{id:"substring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#substring","aria-hidden":"true"}},[t._v("#")]),t._v(" substring")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("substring")]),t._v("(start: "),r("em",[r("code",[t._v("number")])]),t._v(", end?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.substring")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:483")])]),t._v(" "),r("p",[t._v("Returns the substring at the specified location within a String object.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("start")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The zero-based index number indicating the beginning of the substring.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" end")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sup"}})]),t._v(" "),r("h2",{attrs:{id:"sup"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sup","aria-hidden":"true"}},[t._v("#")]),t._v(" sup")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sup")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.sup")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:493")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:83"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tolocalelowercase"}})]),t._v(" "),r("h2",{attrs:{id:"tolocalelowercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalelowercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toLocaleLowerCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toLocaleLowerCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toLocaleLowerCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:489")])]),t._v(" "),r("p",[t._v("Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tolocaleuppercase"}})]),t._v(" "),r("h2",{attrs:{id:"tolocaleuppercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocaleuppercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toLocaleUpperCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toLocaleUpperCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toLocaleUpperCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:495")])]),t._v(" "),r("p",[t._v("Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tolowercase"}})]),t._v(" "),r("h2",{attrs:{id:"tolowercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolowercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toLowerCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toLowerCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toLowerCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:486")])]),t._v(" "),r("p",[t._v("Converts all the alphabetic characters in a string to lowercase.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides String.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:90"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Type.ts:87"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"touppercase"}})]),t._v(" "),r("h2",{attrs:{id:"touppercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#touppercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toUpperCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toUpperCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toUpperCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:492")])]),t._v(" "),r("p",[t._v("Converts all the alphabetic characters in a string to uppercase.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"trim"}})]),t._v(" "),r("h2",{attrs:{id:"trim"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#trim","aria-hidden":"true"}},[t._v("#")]),t._v(" trim")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("trim")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.trim")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:498")])]),t._v(" "),r("p",[t._v("Removes the leading and trailing white space and line terminator characters from a string.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"trimleft"}})]),t._v(" "),r("h2",{attrs:{id:"trimleft"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#trimleft","aria-hidden":"true"}},[t._v("#")]),t._v(" trimLeft")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("trimLeft")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.trimLeft")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:152")])]),t._v(" "),r("p",[t._v("Removes whitespace from the left end of a string.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"trimright"}})]),t._v(" "),r("h2",{attrs:{id:"trimright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#trimright","aria-hidden":"true"}},[t._v("#")]),t._v(" trimRight")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("trimRight")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.trimRight")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:154")])]),t._v(" "),r("p",[t._v("Removes whitespace from the right end of a string.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"valueof"}})]),t._v(" "),r("h2",{attrs:{id:"valueof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#valueof","aria-hidden":"true"}},[t._v("#")]),t._v(" valueOf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("valueOf")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.valueOf")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:512")])]),t._v(" "),r("p",[t._v("Returns the primitive value of the specified object.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/19.ea56dec0.js b/docs/assets/js/19.ea56dec0.js deleted file mode 100644 index a6e5bf265d..0000000000 --- a/docs/assets/js/19.ea56dec0.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{349:function(e,t,a){"use strict";a.r(t);var n=a(46),s=Object(n.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),a("p",[a("a",{attrs:{id:"fees"}})]),e._v(" "),a("h2",{attrs:{id:"fees"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fees","aria-hidden":"true"}},[e._v("#")]),e._v(" fees")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("fees")]),e._v("(api: "),a("em",[a("code",[e._v("ApiInterface$Rx")])]),e._v("): "),a("code",[e._v("(Anonymous function)")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/fees.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("balances/fees.ts:13"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("api")]),e._v(" "),a("td",[a("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("(Anonymous function)")])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/190.58531b65.js b/docs/assets/js/190.58531b65.js deleted file mode 100644 index 0e95e677cf..0000000000 --- a/docs/assets/js/190.58531b65.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[190],{545:function(t,e,r){"use strict";r.r(e);var o=r(46),a=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Bool")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Representation for a boolean value in the system. It extends the base JS "),r("code",[t._v("Boolean")]),t._v(" class")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Boolean")])]),t._v(" "),r("p",[r("strong",[t._v("↳ Bool")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Bool")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")]),t._v(" | "),r("code",[t._v("Boolean")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("boolean")]),t._v(" | "),r("code",[t._v("number")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:15"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")]),t._v(" | "),r("code",[t._v("Boolean")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("boolean")]),t._v(" | "),r("code",[t._v("number")])],1),t._v(" "),r("td",[t._v("false")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"boolean"}})]),t._v(" "),r("h2",{attrs:{id:"static-boolean"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-boolean","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" Boolean")]),t._v(" "),r("p",[r("strong",[t._v("● Boolean")]),t._v(": "),r("em",[r("code",[t._v("BooleanConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:540")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always false)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:49"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Bool.ts:82"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/191.1c94ebe3.js b/docs/assets/js/191.1c94ebe3.js deleted file mode 100644 index 3edc6d69c8..0000000000 --- a/docs/assets/js/191.1c94ebe3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[191],{473:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Bytes")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A Bytes wrapper for Vec. The significant difference between this and a normal Uint8Array is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same as what is found in "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[e._v("Text")]),e._v(" and "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v(")")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Bytes")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[e._v("StorageData")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[e._v("Other")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[e._v("Justification")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.headdata.html"}},[e._v("HeadData")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Bytes")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:61"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/192.91f2c9a1.js b/docs/assets/js/192.91f2c9a1.js deleted file mode 100644 index 608e6bea14..0000000000 --- a/docs/assets/js/192.91f2c9a1.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[192],{488:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Data")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A raw data structure. It is just an encoding of a U8a, without any length encoding")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Data")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Data")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[e._v("Data")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[e._v("Data")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/193.917b4055.js b/docs/assets/js/193.917b4055.js deleted file mode 100644 index c4cebe72af..0000000000 --- a/docs/assets/js/193.917b4055.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[193],{470:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": H160")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Hash containing 160 bits (20 bytes), typically used in blocks, extrinsics and as a sane default for fixed-length hash representations.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ H160")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new H160")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[e._v("H160")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H160.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H160.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[e._v("H160")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/194.ae691468.js b/docs/assets/js/194.ae691468.js deleted file mode 100644 index c2047dd7f2..0000000000 --- a/docs/assets/js/194.ae691468.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[194],{464:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": H256")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Hash containing 256 bits (32 bytes), typically used in blocks, extrinsics and as a sane default for fixed-length hash representations.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ H256")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new H256")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H256.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/195.a6b48df0.js b/docs/assets/js/195.a6b48df0.js deleted file mode 100644 index 00aa49172a..0000000000 --- a/docs/assets/js/195.a6b48df0.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[195],{467:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": H512")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Hash containing 512 bits (64 bytes), typically used for signatures")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ H512")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new H512")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H512.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/196.87f89edc.js b/docs/assets/js/196.87f89edc.js deleted file mode 100644 index daad4166d4..0000000000 --- a/docs/assets/js/196.87f89edc.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[196],{377:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": I128")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 128-bit signed integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ I128")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new I128")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[e._v("I128")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I128.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/I128.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[e._v("I128")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/197.c36f7ea4.js b/docs/assets/js/197.c36f7ea4.js deleted file mode 100644 index 981e3cf159..0000000000 --- a/docs/assets/js/197.c36f7ea4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[197],{374:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": I16")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 16-bit signed integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ I16")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new I16")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[e._v("I16")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I16.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/I16.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[e._v("I16")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/198.525a4b7d.js b/docs/assets/js/198.525a4b7d.js deleted file mode 100644 index 1e6e3ca7d5..0000000000 --- a/docs/assets/js/198.525a4b7d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[198],{371:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": I256")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 256-bit signed integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ I256")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new I256")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[e._v("I256")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I256.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/I256.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[e._v("I256")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/199.5015f2d3.js b/docs/assets/js/199.5015f2d3.js deleted file mode 100644 index bebc56b03a..0000000000 --- a/docs/assets/js/199.5015f2d3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[199],{368:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": I32")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 32-bit signed integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ I32")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new I32")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[e._v("I32")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/I32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[e._v("I32")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/2.16c7e4af.js b/docs/assets/js/2.16c7e4af.js deleted file mode 100644 index 49dbaf7565..0000000000 --- a/docs/assets/js/2.16c7e4af.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[2],{248:function(t,e,n){"use strict";n.d(e,"d",function(){return i}),n.d(e,"a",function(){return r}),n.d(e,"j",function(){return a}),n.d(e,"i",function(){return o}),n.d(e,"f",function(){return u}),n.d(e,"g",function(){return c}),n.d(e,"h",function(){return l}),n.d(e,"b",function(){return h}),n.d(e,"e",function(){return p}),n.d(e,"l",function(){return f}),n.d(e,"m",function(){return d}),n.d(e,"c",function(){return g}),n.d(e,"k",function(){return v});const i=/#.*$/,s=/\.(md|html)$/,r=/\/$/,a=/^(https?:|mailto:|tel:)/;function o(t){return decodeURI(t).replace(i,"").replace(s,"")}function u(t){return a.test(t)}function c(t){return/^mailto:/.test(t)}function l(t){return/^tel:/.test(t)}function h(t){if(u(t))return t;const e=t.match(i),n=e?e[0]:"",s=o(t);return r.test(s)?t:s+".html"+n}function p(t,e){const n=t.hash,s=function(t){const e=t.match(i);if(e)return e[0]}(e);return(!s||n===s)&&o(t.path)===o(e)}function f(t,e,n){n&&(e=function(t,e,n){const i=t.charAt(0);if("/"===i)return t;if("?"===i||"#"===i)return e+t;const s=e.split("/");n&&s[s.length-1]||s.pop();const r=t.replace(/^\//,"").split("/");for(let t=0;t({type:"auto",title:e.title,basePath:t.path,path:t.path+"#"+e.slug,children:e.children||[]}))}]}(t);const o=a.sidebar||r.sidebar;if(o){const{base:t,config:n}=function(t,e){if(Array.isArray(e))return{base:"/",config:e};for(const i in e)if(0===(n=t,/(\.html|\/)$/.test(n)?n:n+"/").indexOf(i))return{base:i,config:e[i]};var n;return{}}(e,o);return n?n.map(e=>(function t(e,n,i,s=1){if("string"==typeof e)return f(n,e,i);if(Array.isArray(e))return Object.assign(f(n,e[0],i),{title:e[1]});{s>3&&console.error("[vuepress] detected a too deep nested sidebar group.");const r=e.children||[];return 0===r.length&&e.path?Object.assign(f(n,e.path,i),{title:e.title}):{type:"group",path:e.path,title:e.title,sidebarDepth:e.sidebarDepth,children:r.map(e=>t(e,n,i,s+1)),collapsable:!1!==e.collapsable}}})(e,s,t)):[]}return[]}function g(t){let e;return(t=t.map(t=>Object.assign({},t))).forEach(t=>{2===t.level?e=t:e&&(e.children||(e.children=[])).push(t)}),t.filter(t=>2===t.level)}function v(t){return Object.assign(t,{type:t.items&&t.items.length?"links":"link"})}},249:function(t,e,n){"use strict";var i=n(8),s=n(66)(3);i(i.P+i.F*!n(47)([].some,!0),"Array",{some:function(t){return s(this,t,arguments[1])}})},251:function(t,e,n){},252:function(t,e,n){},253:function(t,e,n){},254:function(t,e,n){},255:function(t,e,n){},256:function(t,e,n){},257:function(t,e,n){},258:function(t,e,n){},259:function(t,e,n){},260:function(t,e,n){},261:function(t,e,n){},262:function(t,e,n){},263:function(t,e,n){},265:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},266:function(t,e,n){"use strict";var i=n(11),s=n(22),r=n(143),a=n(144);n(145)("match",1,function(t,e,n,o){return[function(n){var i=t(this),s=null==n?void 0:n[e];return void 0!==s?s.call(n,i):new RegExp(n)[e](String(i))},function(t){var e=o(n,t,this);if(e.done)return e.value;var u=i(t),c=String(this);if(!u.global)return a(u,c);var l=u.unicode;u.lastIndex=0;for(var h,p=[],f=0;null!==(h=a(u,c));){var d=String(h[0]);p[f]=d,""===d&&(u.lastIndex=r(c,s(u.lastIndex),l)),f++}return 0===f?null:p}]})},267:function(t,e,n){"use strict";n.r(e);n(249);var i=n(248),s={name:"SidebarGroup",props:["item","open","collapsable","depth"],components:{DropdownTransition:n(268).a},beforeCreate:function(){this.$options.components.SidebarLinks=n(267).default},methods:{isActive:i.e}},r=(n(294),n(46)),a=Object(r.a)(s,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("section",{staticClass:"sidebar-group",class:[{collapsable:t.collapsable,"is-sub-group":0!==t.depth},"depth-"+t.depth]},[t.item.path?n("router-link",{staticClass:"sidebar-heading clickable",class:{open:t.open,active:t.isActive(t.$route,t.item.path)},attrs:{to:t.item.path},nativeOn:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]):n("p",{staticClass:"sidebar-heading",class:{open:t.open},on:{click:function(e){return t.$emit("toggle")}}},[n("span",[t._v(t._s(t.item.title))]),t._v(" "),t.collapsable?n("span",{staticClass:"arrow",class:t.open?"down":"right"}):t._e()]),t._v(" "),n("DropdownTransition",[t.open||!t.collapsable?n("SidebarLinks",{staticClass:"sidebar-group-items",attrs:{items:t.item.children,sidebarDepth:t.item.sidebarDepth,depth:t.depth+1}}):t._e()],1)],1)},[],!1,null,null,null).exports;n(64);function o(t,e,n,i){return t("router-link",{props:{to:e,activeClass:"",exactActiveClass:""},class:{active:i,"sidebar-link":!0}},n)}function u(t,e,n,s,r){var a=arguments.length>5&&void 0!==arguments[5]?arguments[5]:1;return!e||a>r?null:t("ul",{class:"sidebar-sub-headers"},e.map(function(e){var c=Object(i.e)(s,n+"#"+e.slug);return t("li",{class:"sidebar-sub-header"},[o(t,n+"#"+e.slug,e.title,c),u(t,e.children,n,s,r,a+1)])}))}var c={functional:!0,props:["item","sidebarDepth"],render:function(t,e){var n=e.parent,s=n.$page,r=(n.$site,n.$route),a=n.$themeConfig,c=n.$themeLocaleConfig,l=e.props,h=l.item,p=l.sidebarDepth,f=Object(i.e)(r,h.path),d="auto"===h.type?f||h.children.some(function(t){return Object(i.e)(r,h.basePath+"#"+t.slug)}):f,g=o(t,h.path,h.title||h.path,d),v=s.frontmatter.sidebarDepth||p||c.sidebarDepth||a.sidebarDepth,m=null==v?1:v,b=c.displayAllHeaders||a.displayAllHeaders;return"auto"===h.type?[g,u(t,h.children,h.basePath,r,m)]:(d||b)&&h.headers&&!i.d.test(h.path)?[g,u(t,Object(i.c)(h.headers),h.path,r,m)]:g}};n(295);var l={name:"SidebarLinks",components:{SidebarGroup:a,SidebarLink:Object(r.a)(c,void 0,void 0,!1,null,null,null).exports},props:["items","depth","sidebarDepth"],data:function(){return{openGroupIndex:0}},created:function(){this.refreshIndex()},watch:{$route:function(){this.refreshIndex()}},methods:{refreshIndex:function(){var t=function(t,e){for(var n=0;n-1&&(this.openGroupIndex=t)},toggleGroup:function(t){this.openGroupIndex=t===this.openGroupIndex?-1:t},isActive:function(t){return Object(i.e)(this.$route,t.regularPath)}}},h=Object(r.a)(l,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.items.length?n("ul",{staticClass:"sidebar-links"},t._l(t.items,function(e,i){return n("li",{key:i},["group"===e.type?n("SidebarGroup",{attrs:{item:e,open:i===t.openGroupIndex,collapsable:e.collapsable||e.collapsible,depth:t.depth},on:{toggle:function(e){return t.toggleGroup(i)}}}):n("SidebarLink",{attrs:{sidebarDepth:t.sidebarDepth,item:e}})],1)}),0):t._e()},[],!1,null,null,null);e.default=h.exports},268:function(t,e,n){"use strict";var i={name:"DropdownTransition",methods:{setHeight:function(t){t.style.height=t.scrollHeight+"px"},unsetHeight:function(t){t.style.height=""}}},s=(n(289),n(46)),r=Object(s.a)(i,function(){var t=this.$createElement;return(this._self._c||t)("transition",{attrs:{name:"dropdown"},on:{enter:this.setHeight,"after-enter":this.unsetHeight,"before-leave":this.setHeight}},[this._t("default")],2)},[],!1,null,null,null);e.a=r.exports},270:function(t,e,n){"use strict";n(271)("link",function(t){return function(e){return t(this,"a","href",e)}})},271:function(t,e,n){var i=n(8),s=n(27),r=n(28),a=/"/g,o=function(t,e,n,i){var s=String(r(t)),o="<"+e;return""!==n&&(o+=" "+n+'="'+String(i).replace(a,""")+'"'),o+">"+s+""};t.exports=function(t,e){var n={};n[t]=e(o),i(i.P+i.F*s(function(){var e=""[t]('"');return e!==e.toLowerCase()||e.split('"').length>3}),"String",n)}},272:function(t,e,n){"use strict";var i=n(251);n.n(i).a},273:function(t,e,n){t.exports=n(274)},274:function(t,e,n){n(275),t.exports=n(0).parseInt},275:function(t,e,n){var i=n(1),s=n(276);i(i.G+i.F*(parseInt!=s),{parseInt:s})},276:function(t,e,n){var i=n(3).parseInt,s=n(277).trim,r=n(265),a=/^[-+]?0[xX]/;t.exports=8!==i(r+"08")||22!==i(r+"0x16")?function(t,e){var n=s(String(t),3);return i(n,e>>>0||(a.test(n)?16:10))}:i},277:function(t,e,n){var i=n(1),s=n(67),r=n(16),a=n(265),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},278:function(t,e,n){"use strict";var i=n(8),s=n(139)(!1),r=[].indexOf,a=!!r&&1/[1].indexOf(1,-0)<0;i(i.P+i.F*(a||!n(47)(r)),"Array",{indexOf:function(t){return a?r.apply(this,arguments)||0:s(this,t,arguments[1])}})},279:function(t,e,n){"use strict";n(280)("trim",function(t){return function(){return t(this,3)}})},280:function(t,e,n){var i=n(8),s=n(28),r=n(27),a=n(281),o="["+a+"]",u=RegExp("^"+o+o+"*"),c=RegExp(o+o+"*$"),l=function(t,e,n){var s={},o=r(function(){return!!a[t]()||"​…"!="​…"[t]()}),u=s[t]=o?e(h):a[t];n&&(s[n]=u),i(i.P+i.F*o,"String",s)},h=l.trim=function(t,e){return t=String(s(t)),1&e&&(t=t.replace(u,"")),2&e&&(t=t.replace(c,"")),t};t.exports=l},281:function(t,e){t.exports="\t\n\v\f\r   ᠎             　\u2028\u2029\ufeff"},282:function(t,e,n){"use strict";var i=n(252);n.n(i).a},283:function(t,e,n){"use strict";var i=n(253);n.n(i).a},284:function(t,e,n){var i=n(5),s=n(285),r=n(29).f,a=n(288).f,o=n(142),u=n(146),c=i.RegExp,l=c,h=c.prototype,p=/a/g,f=/a/g,d=new c(p)!==p;if(n(21)&&(!d||n(27)(function(){return f[n(2)("match")]=!1,c(p)!=p||c(f)==f||"/a/i"!=c(p,"i")}))){c=function(t,e){var n=this instanceof c,i=o(t),r=void 0===e;return!n&&i&&t.constructor===c&&r?t:s(d?new l(i&&!r?t.source:t,e):l((i=t instanceof c)?t.source:t,i&&r?u.call(t):e),n?this:h,c)};for(var g=function(t){t in c||r(c,t,{configurable:!0,get:function(){return l[t]},set:function(e){l[t]=e}})},v=a(l),m=0;v.length>m;)g(v[m++]);h.constructor=c,c.prototype=h,n(30)(i,"RegExp",c)}n(140)("RegExp")},285:function(t,e,n){var i=n(15),s=n(286).set;t.exports=function(t,e,n){var r,a=e.constructor;return a!==n&&"function"==typeof a&&(r=a.prototype)!==n.prototype&&i(r)&&s&&s(t,r),t}},286:function(t,e,n){var i=n(15),s=n(11),r=function(t,e){if(s(t),!i(e)&&null!==e)throw TypeError(e+": can't set as prototype!")};t.exports={set:Object.setPrototypeOf||("__proto__"in{}?function(t,e,i){try{(i=n(31)(Function.call,n(287).f(Object.prototype,"__proto__").set,2))(t,[]),e=!(t instanceof Array)}catch(t){e=!0}return function(t,n){return r(t,n),e?t.__proto__=n:i(t,n),t}}({},!1):void 0),check:r}},287:function(t,e,n){var i=n(141),s=n(98),r=n(65),a=n(137),o=n(48),u=n(136),c=Object.getOwnPropertyDescriptor;e.f=n(21)?c:function(t,e){if(t=r(t),e=a(e,!0),u)try{return c(t,e)}catch(t){}if(o(t,e))return s(!i.f.call(t,e),t[e])}},288:function(t,e,n){var i=n(138),s=n(99).concat("length","prototype");e.f=Object.getOwnPropertyNames||function(t){return i(t,s)}},289:function(t,e,n){"use strict";var i=n(254);n.n(i).a},290:function(t,e,n){"use strict";var i=n(255);n.n(i).a},291:function(t,e,n){"use strict";var i=n(256);n.n(i).a},292:function(t,e,n){"use strict";var i=n(257);n.n(i).a},293:function(t,e,n){"use strict";var i=n(258);n.n(i).a},294:function(t,e,n){"use strict";var i=n(259);n.n(i).a},295:function(t,e,n){"use strict";var i=n(260);n.n(i).a},296:function(t,e,n){"use strict";var i=n(261);n.n(i).a},297:function(t,e,n){"use strict";var i=n(262);n.n(i).a},298:function(t,e,n){"use strict";var i=n(263);n.n(i).a},300:function(t,e,n){"use strict";n.r(e);var i=n(43),s=n.n(i),r=(n(249),n(270),n(248)),a={props:{item:{required:!0}},computed:{link:function(){return Object(r.b)(this.item.link)},exact:function(){var t=this;return this.$site.locales?s()(this.$site.locales).some(function(e){return e===t.link}):"/"===this.link}},methods:{isExternal:r.f,isMailto:r.g,isTel:r.h}},o=n(46),u=Object(o.a)(a,function(){var t=this,e=t.$createElement,n=t._self._c||e;return t.isExternal(t.link)?n("a",{staticClass:"nav-link external",attrs:{href:t.link,target:t.isMailto(t.link)||t.isTel(t.link)?null:"_blank",rel:t.isMailto(t.link)||t.isTel(t.link)?null:"noopener noreferrer"}},[t._v("\n "+t._s(t.item.text)+"\n "),n("OutboundLink")],1):n("router-link",{staticClass:"nav-link",attrs:{to:t.link,exact:t.exact}},[t._v(t._s(t.item.text))])},[],!1,null,null,null).exports,c={components:{NavLink:u},computed:{data:function(){return this.$page.frontmatter},actionLink:function(){return{link:this.data.actionLink,text:this.data.actionText}}}},l=(n(272),Object(o.a)(c,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("main",{staticClass:"home",attrs:{"aria-labelledby":"main-title"}},[n("header",{staticClass:"hero"},[t.data.heroImage?n("img",{attrs:{src:t.$withBase(t.data.heroImage),alt:t.data.heroAlt||"hero"}}):t._e(),t._v(" "),null!==t.data.heroText?n("h1",{attrs:{id:"main-title"}},[t._v(t._s(t.data.heroText||t.$title||"Hello"))]):t._e(),t._v(" "),n("p",{staticClass:"description"},[t._v("\n "+t._s(t.data.tagline||t.$description||"Welcome to your VuePress site")+"\n ")]),t._v(" "),t.data.actionText&&t.data.actionLink?n("p",{staticClass:"action"},[n("NavLink",{staticClass:"action-button",attrs:{item:t.actionLink}})],1):t._e()]),t._v(" "),t.data.features&&t.data.features.length?n("div",{staticClass:"features"},t._l(t.data.features,function(e,i){return n("div",{key:i,staticClass:"feature"},[n("h2",[t._v(t._s(e.title))]),t._v(" "),n("p",[t._v(t._s(e.details))])])}),0):t._e(),t._v(" "),n("Content",{staticClass:"custom"}),t._v(" "),t.data.footer?n("div",{staticClass:"footer"},[t._v("\n "+t._s(t.data.footer)+"\n ")]):t._e()],1)},[],!1,null,null,null).exports),h=n(273),p=n.n(h),f=(n(266),n(68),n(114)),d=n.n(f),g=n(20),v=n.n(g),m=(n(278),n(279),{data:function(){return{query:"",focused:!1,focusIndex:0}},computed:{showSuggestions:function(){return this.focused&&this.suggestions&&this.suggestions.length},suggestions:function(){var t=this.query.trim().toLowerCase();if(t){for(var e=this.$site.pages,n=this.$localePath,i=function(e){return e.title&&e.title.toLowerCase().indexOf(t)>-1},s=[],r=0;r=5);r++){var a=e[r];if(this.getPageLocalePath(a)===n&&this.isSearchable(a))if(i(a))s.push(a);else if(a.headers)for(var o=0;o=5);o++){var u=a.headers[o];i(u)&&s.push(v()({},a,{path:a.path+"#"+u.slug,header:u}))}}return s}},alignRight:function(){return(this.$site.themeConfig.nav||[]).length+(this.$site.repo?1:0)<=2}},methods:{getPageLocalePath:function(t){for(var e in this.$site.locales||{})if("/"!==e&&0===t.path.indexOf(e))return e;return"/"},isSearchable:function(t){var e=null;return null===e||(e=d()(e)?e:new Array(e)).filter(function(e){return t.path.match(e)}).length>0},onUp:function(){this.showSuggestions&&(this.focusIndex>0?this.focusIndex--:this.focusIndex=this.suggestions.length-1)},onDown:function(){this.showSuggestions&&(this.focusIndex "+t._s(e.header.title))]):t._e()])])}),0):t._e()])},[],!1,null,null,null).exports),_=(n(283),Object(o.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"sidebar-button",on:{click:function(e){return t.$emit("toggle-sidebar")}}},[n("svg",{staticClass:"icon",attrs:{xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",role:"img",viewBox:"0 0 448 512"}},[n("path",{attrs:{fill:"currentColor",d:"M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"}})])])},[],!1,null,null,null).exports),k=(n(284),n(61)),x=(n(135),n(64),{components:{NavLink:u,DropdownTransition:n(268).a},data:function(){return{open:!1}},props:{item:{required:!0}},methods:{toggle:function(){this.open=!this.open}}}),$=(n(290),{components:{NavLink:u,DropdownLink:Object(o.a)(x,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"dropdown-wrapper",class:{open:t.open}},[n("a",{staticClass:"dropdown-title",on:{click:t.toggle}},[n("span",{staticClass:"title"},[t._v(t._s(t.item.text))]),t._v(" "),n("span",{staticClass:"arrow",class:t.open?"down":"right"})]),t._v(" "),n("DropdownTransition",[n("ul",{directives:[{name:"show",rawName:"v-show",value:t.open,expression:"open"}],staticClass:"nav-dropdown"},t._l(t.item.items,function(e,i){return n("li",{key:e.link||i,staticClass:"dropdown-item"},["links"===e.type?n("h4",[t._v(t._s(e.text))]):t._e(),t._v(" "),"links"===e.type?n("ul",{staticClass:"dropdown-subitem-wrapper"},t._l(e.items,function(t){return n("li",{key:t.link,staticClass:"dropdown-subitem"},[n("NavLink",{attrs:{item:t}})],1)}),0):n("NavLink",{attrs:{item:e}})],1)}),0)])],1)},[],!1,null,null,null).exports},computed:{userNav:function(){return this.$themeLocaleConfig.nav||this.$site.themeConfig.nav||[]},nav:function(){var t=this,e=this.$site.locales;if(e&&s()(e).length>1){var n=this.$page.path,i=this.$router.options.routes,r=this.$site.themeConfig.locales||{},a={text:this.$themeLocaleConfig.selectText||"Languages",items:s()(e).map(function(s){var a,o=e[s],u=r[s]&&r[s].label||o.lang;return o.lang===t.$lang?a=n:(a=n.replace(t.$localeConfig.path,s),i.some(function(t){return t.path===a})||(a=s)),{text:u,link:a}})};return[].concat(Object(k.a)(this.userNav),[a])}return this.userNav},userLinks:function(){return(this.nav||[]).map(function(t){return v()(Object(r.k)(t),{items:(t.items||[]).map(r.k)})})},repoLink:function(){var t=this.$site.themeConfig.repo;if(t)return/^https?:/.test(t)?t:"https://github.com/".concat(t)},repoLabel:function(){if(this.repoLink){if(this.$site.themeConfig.repoLabel)return this.$site.themeConfig.repoLabel;for(var t=this.repoLink.match(/^https?:\/\/[^\/]+/)[0],e=["GitHub","GitLab","Bitbucket"],n=0;nMath.abs(n)&&Math.abs(e)>40&&(e>0&&this.touchStart.x<=80?this.toggleSidebar(!0):this.toggleSidebar(!1))}}}),T=(n(297),n(298),Object(o.a)(E,function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("div",{staticClass:"theme-container",class:t.pageClasses,on:{touchstart:t.onTouchStart,touchend:t.onTouchEnd}},[t.shouldShowNavbar?n("Navbar",{on:{"toggle-sidebar":t.toggleSidebar}}):t._e(),t._v(" "),n("div",{staticClass:"sidebar-mask",on:{click:function(e){return t.toggleSidebar(!1)}}}),t._v(" "),n("Sidebar",{attrs:{items:t.sidebarItems},on:{"toggle-sidebar":t.toggleSidebar}},[t._t("sidebar-top",null,{slot:"top"}),t._v(" "),t._t("sidebar-bottom",null,{slot:"bottom"})],2),t._v(" "),t.$page.frontmatter.home?n("Home"):n("Page",{attrs:{"sidebar-items":t.sidebarItems}},[t._t("page-top",null,{slot:"top"}),t._v(" "),t._t("page-bottom",null,{slot:"bottom"})],2)],1)},[],!1,null,null,null));e.default=T.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/20.0e054b48.js b/docs/assets/js/20.0e054b48.js deleted file mode 100644 index 475d3e8c28..0000000000 --- a/docs/assets/js/20.0e054b48.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{351:function(a,t,e){"use strict";e.r(t);var n=e(46),r=Object(n.a)({},function(){var a=this,t=a.$createElement,e=a._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[a._v("#")]),a._v(" Functions")]),a._v(" "),e("p",[e("a",{attrs:{id:"validatingbalance"}})]),a._v(" "),e("h2",{attrs:{id:"validatingbalance"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#validatingbalance","aria-hidden":"true"}},[a._v("#")]),a._v(" validatingBalance")]),a._v(" "),e("p",[a._v("▸ "),e("strong",[a._v("validatingBalance")]),a._v("(api: "),e("em",[e("code",[a._v("ApiInterface$Rx")])]),a._v("): "),e("code",[a._v("(Anonymous function)")])]),a._v(" "),e("p",[e("em",[a._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/validatingBalance.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[a._v("balances/validatingBalance.ts:16"),e("OutboundLink")],1)])]),a._v(" "),e("p",[e("strong",[a._v("Parameters:")])]),a._v(" "),e("table",[e("thead",[e("tr",[e("th",[a._v("Name")]),a._v(" "),e("th",[a._v("Type")])])]),a._v(" "),e("tbody",[e("tr",[e("td",[a._v("api")]),a._v(" "),e("td",[e("code",[a._v("ApiInterface$Rx")])])])])]),a._v(" "),e("p",[e("strong",[a._v("Returns:")]),a._v(" "),e("code",[a._v("(Anonymous function)")])]),a._v(" "),e("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/200.75faeee9.js b/docs/assets/js/200.75faeee9.js deleted file mode 100644 index f6a03de82c..0000000000 --- a/docs/assets/js/200.75faeee9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[200],{365:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": I64")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 64-bit signed integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ I64")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new I64")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[e._v("I64")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I64.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/I64.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[e._v("I64")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/201.44b6271a.js b/docs/assets/js/201.44b6271a.js deleted file mode 100644 index ecdc062419..0000000000 --- a/docs/assets/js/201.44b6271a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{362:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": I8")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 8-bit signed integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ I8")])]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_type_lockperiods_.lockperiods.html"}},[e._v("LocKPeriods")])],1),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[e._v("Vote")])],1),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new I8")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[e._v("I8")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I8.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/I8.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[e._v("I8")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/202.dfcfe327.js b/docs/assets/js/202.dfcfe327.js deleted file mode 100644 index e9688015ec..0000000000 --- a/docs/assets/js/202.dfcfe327.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[202],{619:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Method")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Extrinsic function descriptor, as defined in "),r("a",{attrs:{href:"https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node"),r("OutboundLink")],1),t._v(".")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Method")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Method")]),t._v("(value: "),r("em",[r("code",[t._v("any")])]),t._v(", meta?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L70",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:70"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" meta")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"args"}})]),t._v(" "),r("h2",{attrs:{id:"args"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#args","aria-hidden":"true"}},[t._v("#")]),t._v(" args")]),t._v(" "),r("p",[r("strong",[t._v("get args")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:192"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The arguments for the function call")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"argsdef"}})]),t._v(" "),r("h2",{attrs:{id:"argsdef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#argsdef","aria-hidden":"true"}},[t._v("#")]),t._v(" argsDef")]),t._v(" "),r("p",[r("strong",[t._v("get argsDef")]),t._v("(): "),r("code",[t._v("ArgsDef")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L200",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:200"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Thge argument defintions")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("ArgsDef")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"callindex"}})]),t._v(" "),r("h2",{attrs:{id:"callindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#callindex","aria-hidden":"true"}},[t._v("#")]),t._v(" callIndex")]),t._v(" "),r("p",[r("strong",[t._v("get callIndex")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L207",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:207"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The encoded "),r("code",[t._v("[sectionIndex, methodIndex]")]),t._v(" identifier")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("get data")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L214",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:214"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The encoded data")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hasorigin"}})]),t._v(" "),r("h2",{attrs:{id:"hasorigin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hasorigin","aria-hidden":"true"}},[t._v("#")]),t._v(" hasOrigin")]),t._v(" "),r("p",[r("strong",[t._v("get hasOrigin")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L221",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:221"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": "),r("code",[t._v("true")]),t._v(" if the "),r("code",[t._v("Origin")]),t._v(" type is on the method (extrinsic method)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"meta"}})]),t._v(" "),r("h2",{attrs:{id:"meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),r("p",[r("strong",[t._v("get meta")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L230",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:230"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"filterorigin"}})]),t._v(" "),r("h2",{attrs:{id:"static-filterorigin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-filterorigin","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" filterOrigin")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("filterOrigin")]),t._v("(meta?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:140"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" meta")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"findfunction"}})]),t._v(" "),r("h2",{attrs:{id:"static-findfunction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-findfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" findFunction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("findFunction")]),t._v("(callIndex: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methodfunction.html"}},[t._v("MethodFunction")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:156"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callIndex")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methodfunction.html"}},[t._v("MethodFunction")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"injectmethods"}})]),t._v(" "),r("h2",{attrs:{id:"static-injectmethods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-injectmethods","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" injectMethods")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("injectMethods")]),t._v("(moduleMethods: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.moduleswithmethods.html"}},[t._v("ModulesWithMethods")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L181",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:181"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("moduleMethods")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.moduleswithmethods.html"}},[t._v("ModulesWithMethods")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/203.398e2047.js b/docs/assets/js/203.398e2047.js deleted file mode 100644 index 78c4dbb08b..0000000000 --- a/docs/assets/js/203.398e2047.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[203],{461:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": MethodIndex")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A wrapper around the "),r("code",[e._v("[sectionIndex, methodIndex]")]),e._v(" value that uniquely identifies a method")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ MethodIndex")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new MethodIndex")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.methodindex.html"}},[e._v("MethodIndex")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L57",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Method.ts:57"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.methodindex.html"}},[e._v("MethodIndex")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/204.d9b4f519.js b/docs/assets/js/204.d9b4f519.js deleted file mode 100644 index a46d8b5a24..0000000000 --- a/docs/assets/js/204.d9b4f519.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[204],{546:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Moment")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A wrapper around seconds/timestamps. Internally the representation only has second precicion (aligning with Rust), so any numbers passed an/out are always per-second. For any encoding/decoding the 1000 multiplier would be applied to get it in line with JavaScript formats. It extends the base JS "),r("code",[t._v("Date")]),t._v(" object and has all the methods available that are applicable to any "),r("code",[t._v("Date")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Date")])]),t._v(" "),r("p",[r("strong",[t._v("↳ Moment")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.momentof.html"}},[t._v("MomentOf")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Moment")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("code",[t._v("Date")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("code",[t._v("Date")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(" "),r("td",[t._v("0")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"date"}})]),t._v(" "),r("h2",{attrs:{id:"static-date"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-date","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" Date")]),t._v(" "),r("p",[r("strong",[t._v("● Date")]),t._v(": "),r("em",[r("code",[t._v("DateConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:907")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:58"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),t._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" bitLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("bitLength")]),t._v("(): "),r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:72"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the number of bits in the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:65"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tobn"}})]),t._v(" "),r("h2",{attrs:{id:"tobn"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[t._v("#")]),t._v(" toBn")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toBn")]),t._v("(): "),r("code",[t._v("BN")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:79"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the BN representation of the timestamp")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("BN")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:86"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Date.toJSON")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:93"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),t._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" toNumber")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toNumber")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:100"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the number representation for the timestamp")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Date.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:107"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L116",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:116"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodemoment"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodemoment"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodemoment","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeMoment")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeMoment")]),t._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("code",[t._v("Date")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v("): "),r("code",[t._v("Date")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Moment.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("code",[t._v("Date")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Date")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/205.2657056f.js b/docs/assets/js/205.2657056f.js deleted file mode 100644 index ecf1020c15..0000000000 --- a/docs/assets/js/205.2657056f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[205],{458:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": MomentOf")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The Substrate MomentOf representation as a "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v(".")],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ MomentOf")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new MomentOf")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v(" | "),v("code",[e._v("Date")]),e._v(" | "),v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.momentof.html"}},[e._v("MomentOf")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:24"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Default value")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v(" | "),v("code",[e._v("Date")]),e._v(" | "),v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(" "),v("td",[e._v("0")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.momentof.html"}},[e._v("MomentOf")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"properties"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),v("p",[v("a",{attrs:{id:"getvardate"}})]),e._v(" "),v("h2",{attrs:{id:"getvardate"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getvardate","aria-hidden":"true"}},[e._v("#")]),e._v(" getVarDate")]),e._v(" "),v("p",[v("strong",[e._v("● getVarDate")]),e._v(": "),v("em",[v("code",[e._v("function")])])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getVarDate")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.scripthost.d.ts:326")])]),e._v(" "),v("h4",{attrs:{id:"type-declaration"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),v("p",[e._v("▸(): "),v("code",[e._v("VarDate")])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("VarDate")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:51"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:58"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"___toprimitive"}})]),e._v(" "),v("h2",{attrs:{id:"toprimitive"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toprimitive","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toPrimitive")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("__@toPrimitive")]),e._v("(hint: "),v("em",[e._v('"default"')]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("__@toPrimitive")]),e._v("(hint: "),v("em",[e._v('"string"')]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("__@toPrimitive")]),e._v("(hint: "),v("em",[e._v('"number"')]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("__@toPrimitive")]),e._v("(hint: "),v("em",[v("code",[e._v("string")])]),e._v("): "),v("code",[e._v("string")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.[Symbol.toPrimitive]")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:109")])]),e._v(" "),v("p",[e._v("Converts a Date object to a string.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("hint")]),e._v(" "),v("td",[e._v('"default"')])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.[Symbol.toPrimitive]")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:113")])]),e._v(" "),v("p",[e._v("Converts a Date object to a string.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("hint")]),e._v(" "),v("td",[e._v('"string"')])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.[Symbol.toPrimitive]")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:117")])]),e._v(" "),v("p",[e._v("Converts a Date object to a number.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("hint")]),e._v(" "),v("td",[e._v('"number"')])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.[Symbol.toPrimitive]")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:126")])]),e._v(" "),v("p",[e._v("Converts a Date object to a string or number.")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("throws")])]),e._v(': {TypeError} If \'hint\' was given something other than "number", "string", or "default".')]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("hint")]),e._v(" "),v("td",[v("code",[e._v("string")])]),e._v(" "),v("td",[e._v('The strings "number", "string", or "default" to specify what primitive to return.')])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")]),e._v(" | "),v("code",[e._v("number")]),e._v('\nA number if \'hint\' was "number", a string if \'hint\' was "string" or "default".')]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:72"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:65"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getdate"}})]),e._v(" "),v("h2",{attrs:{id:"getdate"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getdate","aria-hidden":"true"}},[e._v("#")]),e._v(" getDate")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getDate")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getDate")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:755")])]),e._v(" "),v("p",[e._v("Gets the day-of-the-month, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getday"}})]),e._v(" "),v("h2",{attrs:{id:"getday"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getday","aria-hidden":"true"}},[e._v("#")]),e._v(" getDay")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getDay")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getDay")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:759")])]),e._v(" "),v("p",[e._v("Gets the day of the week, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getfullyear"}})]),e._v(" "),v("h2",{attrs:{id:"getfullyear"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getfullyear","aria-hidden":"true"}},[e._v("#")]),e._v(" getFullYear")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getFullYear")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getFullYear")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:747")])]),e._v(" "),v("p",[e._v("Gets the year, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gethours"}})]),e._v(" "),v("h2",{attrs:{id:"gethours"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gethours","aria-hidden":"true"}},[e._v("#")]),e._v(" getHours")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getHours")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getHours")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:763")])]),e._v(" "),v("p",[e._v("Gets the hours in a date, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getmilliseconds"}})]),e._v(" "),v("h2",{attrs:{id:"getmilliseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getmilliseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" getMilliseconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getMilliseconds")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getMilliseconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:775")])]),e._v(" "),v("p",[e._v("Gets the milliseconds of a Date, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getminutes"}})]),e._v(" "),v("h2",{attrs:{id:"getminutes"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getminutes","aria-hidden":"true"}},[e._v("#")]),e._v(" getMinutes")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getMinutes")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getMinutes")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:767")])]),e._v(" "),v("p",[e._v("Gets the minutes of a Date object, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getmonth"}})]),e._v(" "),v("h2",{attrs:{id:"getmonth"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getmonth","aria-hidden":"true"}},[e._v("#")]),e._v(" getMonth")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getMonth")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getMonth")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:751")])]),e._v(" "),v("p",[e._v("Gets the month, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getseconds"}})]),e._v(" "),v("h2",{attrs:{id:"getseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" getSeconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getSeconds")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getSeconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:771")])]),e._v(" "),v("p",[e._v("Gets the seconds of a Date object, using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gettime"}})]),e._v(" "),v("h2",{attrs:{id:"gettime"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gettime","aria-hidden":"true"}},[e._v("#")]),e._v(" getTime")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getTime")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getTime")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:745")])]),e._v(" "),v("p",[e._v("Gets the time value in milliseconds.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gettimezoneoffset"}})]),e._v(" "),v("h2",{attrs:{id:"gettimezoneoffset"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gettimezoneoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" getTimezoneOffset")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getTimezoneOffset")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getTimezoneOffset")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:779")])]),e._v(" "),v("p",[e._v("Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutcdate"}})]),e._v(" "),v("h2",{attrs:{id:"getutcdate"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutcdate","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCDate")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCDate")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCDate")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:757")])]),e._v(" "),v("p",[e._v("Gets the day-of-the-month, using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutcday"}})]),e._v(" "),v("h2",{attrs:{id:"getutcday"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutcday","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCDay")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCDay")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCDay")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:761")])]),e._v(" "),v("p",[e._v("Gets the day of the week using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutcfullyear"}})]),e._v(" "),v("h2",{attrs:{id:"getutcfullyear"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutcfullyear","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCFullYear")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCFullYear")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCFullYear")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:749")])]),e._v(" "),v("p",[e._v("Gets the year using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutchours"}})]),e._v(" "),v("h2",{attrs:{id:"getutchours"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutchours","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCHours")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCHours")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCHours")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:765")])]),e._v(" "),v("p",[e._v("Gets the hours value in a Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutcmilliseconds"}})]),e._v(" "),v("h2",{attrs:{id:"getutcmilliseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutcmilliseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCMilliseconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCMilliseconds")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCMilliseconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:777")])]),e._v(" "),v("p",[e._v("Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutcminutes"}})]),e._v(" "),v("h2",{attrs:{id:"getutcminutes"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutcminutes","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCMinutes")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCMinutes")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCMinutes")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:769")])]),e._v(" "),v("p",[e._v("Gets the minutes of a Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutcmonth"}})]),e._v(" "),v("h2",{attrs:{id:"getutcmonth"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutcmonth","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCMonth")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCMonth")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCMonth")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:753")])]),e._v(" "),v("p",[e._v("Gets the month of a Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"getutcseconds"}})]),e._v(" "),v("h2",{attrs:{id:"getutcseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#getutcseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" getUTCSeconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getUTCSeconds")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.getUTCSeconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:773")])]),e._v(" "),v("p",[e._v("Gets the seconds of a Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setdate"}})]),e._v(" "),v("h2",{attrs:{id:"setdate"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setdate","aria-hidden":"true"}},[e._v("#")]),e._v(" setDate")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setDate")]),e._v("(date: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setDate")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:842")])]),e._v(" "),v("p",[e._v("Sets the numeric day-of-the-month value of the Date object using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("date")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the day of the month.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setfullyear"}})]),e._v(" "),v("h2",{attrs:{id:"setfullyear"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setfullyear","aria-hidden":"true"}},[e._v("#")]),e._v(" setFullYear")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setFullYear")]),e._v("(year: "),v("em",[v("code",[e._v("number")])]),e._v(", month?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", date?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setFullYear")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:866")])]),e._v(" "),v("p",[e._v("Sets the year of the Date object using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("year")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value for the year.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" month")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" date")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal for the day of the month.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sethours"}})]),e._v(" "),v("h2",{attrs:{id:"sethours"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sethours","aria-hidden":"true"}},[e._v("#")]),e._v(" setHours")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setHours")]),e._v("(hours: "),v("em",[v("code",[e._v("number")])]),e._v(", min?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", sec?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", ms?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setHours")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:829")])]),e._v(" "),v("p",[e._v("Sets the hour value in the Date object using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("hours")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the hours value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" min")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the minutes value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" sec")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the seconds value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" ms")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the milliseconds value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setmilliseconds"}})]),e._v(" "),v("h2",{attrs:{id:"setmilliseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setmilliseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" setMilliseconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setMilliseconds")]),e._v("(ms: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setMilliseconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:789")])]),e._v(" "),v("p",[e._v("Sets the milliseconds value in the Date object using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ms")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the millisecond value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setminutes"}})]),e._v(" "),v("h2",{attrs:{id:"setminutes"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setminutes","aria-hidden":"true"}},[e._v("#")]),e._v(" setMinutes")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setMinutes")]),e._v("(min: "),v("em",[v("code",[e._v("number")])]),e._v(", sec?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", ms?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setMinutes")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:814")])]),e._v(" "),v("p",[e._v("Sets the minutes value in the Date object using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("min")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the minutes value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" sec")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the seconds value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" ms")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the milliseconds value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setmonth"}})]),e._v(" "),v("h2",{attrs:{id:"setmonth"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setmonth","aria-hidden":"true"}},[e._v("#")]),e._v(" setMonth")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setMonth")]),e._v("(month: "),v("em",[v("code",[e._v("number")])]),e._v(", date?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setMonth")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:853")])]),e._v(" "),v("p",[e._v("Sets the month value in the Date object using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("month")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" date")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setseconds"}})]),e._v(" "),v("h2",{attrs:{id:"setseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" setSeconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setSeconds")]),e._v("(sec: "),v("em",[v("code",[e._v("number")])]),e._v(", ms?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setSeconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:801")])]),e._v(" "),v("p",[e._v("Sets the seconds value in the Date object using local time.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("sec")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the seconds value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" ms")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the milliseconds value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"settime"}})]),e._v(" "),v("h2",{attrs:{id:"settime"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#settime","aria-hidden":"true"}},[e._v("#")]),e._v(" setTime")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setTime")]),e._v("(time: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setTime")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:784")])]),e._v(" "),v("p",[e._v("Sets the date and time value in the Date object.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("time")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setutcdate"}})]),e._v(" "),v("h2",{attrs:{id:"setutcdate"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setutcdate","aria-hidden":"true"}},[e._v("#")]),e._v(" setUTCDate")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setUTCDate")]),e._v("(date: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setUTCDate")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:847")])]),e._v(" "),v("p",[e._v("Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("date")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the day of the month.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setutcfullyear"}})]),e._v(" "),v("h2",{attrs:{id:"setutcfullyear"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setutcfullyear","aria-hidden":"true"}},[e._v("#")]),e._v(" setUTCFullYear")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setUTCFullYear")]),e._v("(year: "),v("em",[v("code",[e._v("number")])]),e._v(", month?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", date?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setUTCFullYear")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:873")])]),e._v(" "),v("p",[e._v("Sets the year value in the Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("year")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the year.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" month")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" date")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the day of the month.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setutchours"}})]),e._v(" "),v("h2",{attrs:{id:"setutchours"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setutchours","aria-hidden":"true"}},[e._v("#")]),e._v(" setUTCHours")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setUTCHours")]),e._v("(hours: "),v("em",[v("code",[e._v("number")])]),e._v(", min?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", sec?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", ms?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setUTCHours")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:837")])]),e._v(" "),v("p",[e._v("Sets the hours value in the Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("hours")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the hours value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" min")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the minutes value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" sec")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the seconds value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" ms")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the milliseconds value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setutcmilliseconds"}})]),e._v(" "),v("h2",{attrs:{id:"setutcmilliseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setutcmilliseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" setUTCMilliseconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setUTCMilliseconds")]),e._v("(ms: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setUTCMilliseconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:794")])]),e._v(" "),v("p",[e._v("Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ms")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the millisecond value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setutcminutes"}})]),e._v(" "),v("h2",{attrs:{id:"setutcminutes"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setutcminutes","aria-hidden":"true"}},[e._v("#")]),e._v(" setUTCMinutes")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setUTCMinutes")]),e._v("(min: "),v("em",[v("code",[e._v("number")])]),e._v(", sec?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(", ms?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setUTCMinutes")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:821")])]),e._v(" "),v("p",[e._v("Sets the minutes value in the Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("min")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the minutes value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" sec")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the seconds value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" ms")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the milliseconds value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setutcmonth"}})]),e._v(" "),v("h2",{attrs:{id:"setutcmonth"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setutcmonth","aria-hidden":"true"}},[e._v("#")]),e._v(" setUTCMonth")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setUTCMonth")]),e._v("(month: "),v("em",[v("code",[e._v("number")])]),e._v(", date?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setUTCMonth")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:859")])]),e._v(" "),v("p",[e._v("Sets the month value in the Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("month")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" date")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setutcseconds"}})]),e._v(" "),v("h2",{attrs:{id:"setutcseconds"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setutcseconds","aria-hidden":"true"}},[e._v("#")]),e._v(" setUTCSeconds")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setUTCSeconds")]),e._v("(sec: "),v("em",[v("code",[e._v("number")])]),e._v(", ms?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.setUTCSeconds")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:807")])]),e._v(" "),v("p",[e._v("Sets the seconds value in the Date object using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("sec")]),e._v(" "),v("td",[v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the seconds value.")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" ms")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("A numeric value equal to the milliseconds value.")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#tobn"}},[e._v("toBn")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:79"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the timestamp")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"todatestring"}})]),e._v(" "),v("h2",{attrs:{id:"todatestring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#todatestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toDateString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toDateString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.toDateString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:733")])]),e._v(" "),v("p",[e._v("Returns a date as a string value.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:86"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toisostring"}})]),e._v(" "),v("h2",{attrs:{id:"toisostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toisostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toISOString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toISOString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.toISOString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:877")])]),e._v(" "),v("p",[e._v("Returns a date as a string value in ISO format.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides Date.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:93"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tolocaledatestring"}})]),e._v(" "),v("h2",{attrs:{id:"tolocaledatestring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tolocaledatestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleDateString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toLocaleDateString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.toLocaleDateString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:739")])]),e._v(" "),v("p",[e._v("Returns a date as a string value appropriate to the host environment's current locale.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),v("h2",{attrs:{id:"tolocalestring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toLocaleString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.toLocaleString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:737")])]),e._v(" "),v("p",[e._v("Returns a value as a string value appropriate to the host environment's current locale.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tolocaletimestring"}})]),e._v(" "),v("h2",{attrs:{id:"tolocaletimestring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tolocaletimestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleTimeString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toLocaleTimeString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.toLocaleTimeString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:741")])]),e._v(" "),v("p",[e._v("Returns a time as a string value appropriate to the host environment's current locale.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:100"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number representation for the timestamp")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides Date.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:107"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totimestring"}})]),e._v(" "),v("h2",{attrs:{id:"totimestring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totimestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toTimeString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTimeString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.toTimeString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:735")])]),e._v(" "),v("p",[e._v("Returns a time as a string value.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L116",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:116"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toutcstring"}})]),e._v(" "),v("h2",{attrs:{id:"toutcstring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toutcstring","aria-hidden":"true"}},[e._v("#")]),e._v(" toUTCString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toUTCString")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.toUTCString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:875")])]),e._v(" "),v("p",[e._v("Returns a date converted to a string using Universal Coordinated Time (UTC).")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"valueof"}})]),e._v(" "),v("h2",{attrs:{id:"valueof"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#valueof","aria-hidden":"true"}},[e._v("#")]),e._v(" valueOf")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("valueOf")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from Date.valueOf")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:743")])]),e._v(" "),v("p",[e._v("Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodemoment"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodemoment"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodemoment","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeMoment")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeMoment")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v(" | "),v("code",[e._v("Date")]),e._v(" | "),v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("code",[e._v("Date")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html#decodemoment"}},[e._v("decodeMoment")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Moment.ts:34"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[e._v("Moment")]),e._v(" | "),v("code",[e._v("Date")]),e._v(" | "),v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Date")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/206.e65453db.js b/docs/assets/js/206.e65453db.js deleted file mode 100644 index 34bd0b8814..0000000000 --- a/docs/assets/js/206.e65453db.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[206],{548:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Null")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Implements a type that does not contain anything (apart from "),r("code",[t._v("null")]),t._v(")")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("Null")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.default.html"}},[t._v("Default")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.optional.html"}},[t._v("Optional")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[t._v("Finalization")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("Origin")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/207.4de69828.js b/docs/assets/js/207.4de69828.js deleted file mode 100644 index 69836db2da..0000000000 --- a/docs/assets/js/207.4de69828.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[207],{455:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": StorageData")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Data retrieved via Storage queries and data for KeyValue pairs")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ StorageData")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new StorageData")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[e._v("StorageData")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[e._v("StorageData")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:61"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/208.984d51cb.js b/docs/assets/js/208.984d51cb.js deleted file mode 100644 index 84b5ff0fc0..0000000000 --- a/docs/assets/js/208.984d51cb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[208],{452:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": StorageKey")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A representation of a storage key (typically hashed) in the system. It can be constructed by passing in a raw key or a StorageFunction with (optional) arguments.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ StorageKey")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new StorageKey")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/StorageKey.ts:28"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:61"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"meta"}})]),e._v(" "),r("h2",{attrs:{id:"meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[e._v("#")]),e._v(" meta")]),e._v(" "),r("p",[r("strong",[e._v("get meta")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[e._v("StorageFunctionMetadata")]),e._v(" | "),r("code",[e._v("null")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/StorageKey.ts:82"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The metadata or "),r("code",[e._v("null")]),e._v(" when not available")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[e._v("StorageFunctionMetadata")]),e._v(" | "),r("code",[e._v("null")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"outputtype"}})]),e._v(" "),r("h2",{attrs:{id:"outputtype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#outputtype","aria-hidden":"true"}},[e._v("#")]),e._v(" outputType")]),e._v(" "),r("p",[r("strong",[e._v("get outputType")]),e._v("(): "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L89",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/StorageKey.ts:89"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The output type, "),r("code",[e._v("null")]),e._v(" when not available")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodestoragekey"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodestoragekey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodestoragekey","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeStorageKey")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeStorageKey")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/StorageKey.ts:37"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"getmeta"}})]),e._v(" "),r("h2",{attrs:{id:"static-getmeta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-getmeta","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" getMeta")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getMeta")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[e._v("StorageFunctionMetadata")]),e._v(" | "),r("code",[e._v("null")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/StorageKey.ts:51"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[e._v("StorageFunctionMetadata")]),e._v(" | "),r("code",[e._v("null")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"gettype"}})]),e._v(" "),r("h2",{attrs:{id:"static-gettype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-gettype","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" getType")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("getType")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1),e._v("): "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/StorageKey.ts:65"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")]),e._v(" | "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(" | ["),r("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[e._v("StorageFunction")]),e._v(", "),r("code",[e._v("any")]),e._v("]")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("null")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/209.643919d7.js b/docs/assets/js/209.643919d7.js deleted file mode 100644 index 984ed8d271..0000000000 --- a/docs/assets/js/209.643919d7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[209],{549:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Text")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": This is a string wrapper, along with the length. It is used both for strings as well as items such as documentation. It simply extends the standard JS "),r("code",[t._v("String")]),t._v(" built-in object, inheriting all methods exposed from "),r("code",[t._v("String")]),t._v(".")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("String")])]),t._v(" "),r("p",[r("strong",[t._v("↳ Text")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[index: "),r("code",[t._v("number")]),t._v("]: "),r("code",[t._v("string")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Text")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(" | "),r("code",[t._v("object")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(" | "),r("code",[t._v("object")])],1),t._v(" "),r("td",[t._v('""')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"string"}})]),t._v(" "),r("h2",{attrs:{id:"static-string"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-string","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" String")]),t._v(" "),r("p",[r("strong",[t._v("● String")]),t._v(": "),r("em",[r("code",[t._v("StringConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:527")])]),t._v(" "),r("p",[t._v("Allows manipulation and formatting of text strings and determination and location of substrings within strings.")]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),t._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[t._v("#")]),t._v(" length")]),t._v(" "),r("p",[r("strong",[t._v("get length")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.length")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:83"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides String.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:90"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L99",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:99"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/21.60f7dc48.js b/docs/assets/js/21.60f7dc48.js deleted file mode 100644 index 6134964307..0000000000 --- a/docs/assets/js/21.60f7dc48.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{352:function(a,t,e){"use strict";e.r(t);var n=e(46),s=Object(n.a)({},function(){var a=this,t=a.$createElement,e=a._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[a._v("#")]),a._v(" Functions")]),a._v(" "),e("p",[e("a",{attrs:{id:"validatingbalances"}})]),a._v(" "),e("h2",{attrs:{id:"validatingbalances"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#validatingbalances","aria-hidden":"true"}},[a._v("#")]),a._v(" validatingBalances")]),a._v(" "),e("p",[a._v("▸ "),e("strong",[a._v("validatingBalances")]),a._v("(api: "),e("em",[e("code",[a._v("ApiInterface$Rx")])]),a._v("): "),e("code",[a._v("(Anonymous function)")])]),a._v(" "),e("p",[e("em",[a._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/validatingBalances.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[a._v("balances/validatingBalances.ts:14"),e("OutboundLink")],1)])]),a._v(" "),e("p",[e("strong",[a._v("Parameters:")])]),a._v(" "),e("table",[e("thead",[e("tr",[e("th",[a._v("Name")]),a._v(" "),e("th",[a._v("Type")])])]),a._v(" "),e("tbody",[e("tr",[e("td",[a._v("api")]),a._v(" "),e("td",[e("code",[a._v("ApiInterface$Rx")])])])])]),a._v(" "),e("p",[e("strong",[a._v("Returns:")]),a._v(" "),e("code",[a._v("(Anonymous function)")])]),a._v(" "),e("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/210.b211216d.js b/docs/assets/js/210.b211216d.js deleted file mode 100644 index 869c7f1611..0000000000 --- a/docs/assets/js/210.b211216d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[210],{449:function(t,e,r){"use strict";r.r(e);var v=r(46),_=Object(v.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Type")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": This is a extended version of String, specifically to handle types. Here we rely fully on what string provides us, however we also adjust the types received from the runtime, i.e. we remove the "),r("code",[t._v("T::")]),t._v(" prefixes found in some types for consistency accross implementation.")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Type")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[t._v("PlainType")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[index: "),r("code",[t._v("number")]),t._v("]: "),r("code",[t._v("string")])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Type")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Type.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("string")])],1),t._v(" "),r("td",[t._v('""')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Type.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),t._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[t._v("#")]),t._v(" length")]),t._v(" "),r("p",[r("strong",[t._v("get length")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#length"}},[t._v("length")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides String.length")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:235")])]),t._v(" "),r("p",[t._v("Iterator")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"anchor"}})]),t._v(" "),r("h2",{attrs:{id:"anchor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#anchor","aria-hidden":"true"}},[t._v("#")]),t._v(" anchor")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("anchor")]),t._v("(name: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.anchor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:454")])]),t._v(" "),r("p",[t._v("Returns an HTML anchor element and sets the name attribute to the text value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td")])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"big"}})]),t._v(" "),r("h2",{attrs:{id:"big"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#big","aria-hidden":"true"}},[t._v("#")]),t._v(" big")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("big")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.big")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:457")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"blink"}})]),t._v(" "),r("h2",{attrs:{id:"blink"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#blink","aria-hidden":"true"}},[t._v("#")]),t._v(" blink")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("blink")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.blink")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:460")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"bold"}})]),t._v(" "),r("h2",{attrs:{id:"bold"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bold","aria-hidden":"true"}},[t._v("#")]),t._v(" bold")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("bold")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.bold")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:463")])]),t._v(" "),r("p",[t._v("Returns a "),r("strong",[t._v("HTML element")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"charat"}})]),t._v(" "),r("h2",{attrs:{id:"charat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#charat","aria-hidden":"true"}},[t._v("#")]),t._v(" charAt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("charAt")]),t._v("(pos: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.charAt")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:402")])]),t._v(" "),r("p",[t._v("Returns the character at the specified index.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("pos")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The zero-based index of the desired character.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"charcodeat"}})]),t._v(" "),r("h2",{attrs:{id:"charcodeat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#charcodeat","aria-hidden":"true"}},[t._v("#")]),t._v(" charCodeAt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("charCodeAt")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.charCodeAt")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:408")])]),t._v(" "),r("p",[t._v("Returns the Unicode value of the character at the specified location.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"codepointat"}})]),t._v(" "),r("h2",{attrs:{id:"codepointat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codepointat","aria-hidden":"true"}},[t._v("#")]),t._v(" codePointAt")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("codePointAt")]),t._v("(pos: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.codePointAt")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:402")])]),t._v(" "),r("p",[t._v("Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("pos")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),t._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[t._v("#")]),t._v(" concat")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("concat")]),t._v("(...strings: "),r("em",[r("code",[t._v("string")]),t._v("[]")]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.concat")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:414")])]),t._v(" "),r("p",[t._v("Returns a string that contains the concatenation of two or more strings.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Rest")]),t._v(" strings")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v("[]")]),t._v(" "),r("td",[t._v("The strings to append to the end of the string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"endswith"}})]),t._v(" "),r("h2",{attrs:{id:"endswith"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#endswith","aria-hidden":"true"}},[t._v("#")]),t._v(" endsWith")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("endsWith")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", endPosition?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.endsWith")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:418")])]),t._v(" "),r("p",[t._v("Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" endPosition")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"fixed"}})]),t._v(" "),r("h2",{attrs:{id:"fixed"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fixed","aria-hidden":"true"}},[t._v("#")]),t._v(" fixed")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fixed")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fixed")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:466")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"fontcolor"}})]),t._v(" "),r("h2",{attrs:{id:"fontcolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fontcolor","aria-hidden":"true"}},[t._v("#")]),t._v(" fontcolor")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fontcolor")]),t._v("(color: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fontcolor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:469")])]),t._v(" "),r("p",[t._v("Returns a HTML element and sets the color attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("color")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"fontsize"}})]),t._v(" "),r("h2",{attrs:{id:"fontsize"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fontsize","aria-hidden":"true"}},[t._v("#")]),t._v(" fontsize")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fontsize")]),t._v("(size: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("fontsize")]),t._v("(size: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fontsize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:472")])]),t._v(" "),r("p",[t._v("Returns a HTML element and sets the size attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("size")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.fontsize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:475")])]),t._v(" "),r("p",[t._v("Returns a HTML element and sets the size attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("size")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),t._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[t._v("#")]),t._v(" includes")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("includes")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.includes")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:411")])]),t._v(" "),r("p",[t._v("Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("search string")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("If position is undefined, 0 is assumed, so as to search all of the String.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),t._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[t._v("#")]),t._v(" indexOf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("indexOf")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.indexOf")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:421")])]),t._v(" "),r("p",[t._v("Returns the position of the first occurrence of a substring.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("The substring to search for in the string")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"italics"}})]),t._v(" "),r("h2",{attrs:{id:"italics"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#italics","aria-hidden":"true"}},[t._v("#")]),t._v(" italics")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("italics")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.italics")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:478")])]),t._v(" "),r("p",[t._v("Returns an "),r("em",[t._v("HTML element")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),t._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[t._v("#")]),t._v(" lastIndexOf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("lastIndexOf")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.lastIndexOf")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:428")])]),t._v(" "),r("p",[t._v("Returns the last occurrence of a substring in the string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("The substring to search for.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index at which to begin searching. If omitted, the search begins at the end of the string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"link"}})]),t._v(" "),r("h2",{attrs:{id:"link"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#link","aria-hidden":"true"}},[t._v("#")]),t._v(" link")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("link")]),t._v("(url: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.link")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:481")])]),t._v(" "),r("p",[t._v("Returns an HTML element and sets the href attribute value")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("url")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"localecompare"}})]),t._v(" "),r("h2",{attrs:{id:"localecompare"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#localecompare","aria-hidden":"true"}},[t._v("#")]),t._v(" localeCompare")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("localeCompare")]),t._v("(that: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.localeCompare")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:434")])]),t._v(" "),r("p",[t._v("Determines whether two strings are equivalent in the current locale.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("that")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("String to compare to target string")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"match"}})]),t._v(" "),r("h2",{attrs:{id:"match"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#match","aria-hidden":"true"}},[t._v("#")]),t._v(" match")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("match")]),t._v("(regexp: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v("): "),r("code",[t._v("RegExpMatchArray")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.match")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.match")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:440")])]),t._v(" "),r("p",[t._v("Matches a string with a regular expression, and returns an array containing the results of that search.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("regexp")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A variable name or string literal containing the regular expression pattern and flags.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("RegExpMatchArray")]),t._v(" | "),r("code",[t._v("null")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"normalize"}})]),t._v(" "),r("h2",{attrs:{id:"normalize"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#normalize","aria-hidden":"true"}},[t._v("#")]),t._v(" normalize")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("normalize")]),t._v("(form: "),r("em",[t._v('"NFC" | "NFD" | "NFKC" | "NFKD"')]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("normalize")]),t._v("(form?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.normalize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:426")])]),t._v(" "),r("p",[t._v("Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("form")]),t._v(" "),r("td",[t._v('"NFC" | "NFD" | "NFKC" | "NFKD"')]),t._v(" "),r("td",[t._v('Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.normalize")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:434")])]),t._v(" "),r("p",[t._v("Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" form")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(" "),r("td",[t._v('Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"padend"}})]),t._v(" "),r("h2",{attrs:{id:"padend"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#padend","aria-hidden":"true"}},[t._v("#")]),t._v(" padEnd")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("padEnd")]),t._v("(maxLength: "),r("em",[r("code",[t._v("number")])]),t._v(", fillString?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.padEnd")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:46")])]),t._v(" "),r("p",[t._v("Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("maxLength")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" fillString")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(" "),r("td",[t._v('The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"padstart"}})]),t._v(" "),r("h2",{attrs:{id:"padstart"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#padstart","aria-hidden":"true"}},[t._v("#")]),t._v(" padStart")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("padStart")]),t._v("(maxLength: "),r("em",[r("code",[t._v("number")])]),t._v(", fillString?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.padStart")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:33")])]),t._v(" "),r("p",[t._v("Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("maxLength")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" fillString")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v(" "),r("td",[t._v('The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).')])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"repeat"}})]),t._v(" "),r("h2",{attrs:{id:"repeat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#repeat","aria-hidden":"true"}},[t._v("#")]),t._v(" repeat")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("repeat")]),t._v("(count: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.repeat")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:441")])]),t._v(" "),r("p",[t._v("Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("count")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("number of copies to append")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"replace"}})]),t._v(" "),r("h2",{attrs:{id:"replace"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#replace","aria-hidden":"true"}},[t._v("#")]),t._v(" replace")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("replace")]),t._v("(searchValue: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(", replaceValue: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("replace")]),t._v("(searchValue: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(", replacer: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:447")])]),t._v(" "),r("p",[t._v("Replaces text in a string, using a regular expression or search string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchValue")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A string to search for.")])]),t._v(" "),r("tr",[r("td",[t._v("replaceValue")]),t._v(" "),r("td",[r("code",[t._v("string")])]),t._v(" "),r("td",[t._v("A string containing the text to replace for every successful match of searchValue in this string.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.replace")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:454")])]),t._v(" "),r("p",[t._v("Replaces text in a string, using a regular expression or search string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchValue")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A string to search for.")])]),t._v(" "),r("tr",[r("td",[t._v("replacer")]),t._v(" "),r("td",[r("code",[t._v("function")])]),t._v(" "),r("td",[t._v("A function that returns the replacement text.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"search"}})]),t._v(" "),r("h2",{attrs:{id:"search"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#search","aria-hidden":"true"}},[t._v("#")]),t._v(" search")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("search")]),t._v("(regexp: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v("): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.search")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.search")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:460")])]),t._v(" "),r("p",[t._v("Finds the first substring match in a regular expression search.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("regexp")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("The regular expression pattern and applicable flags.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),t._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[t._v("#")]),t._v(" slice")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("slice")]),t._v("(start?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(", end?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.slice")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:468")])]),t._v(" "),r("p",[t._v("Returns a section of a string.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" start")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index to the beginning of the specified portion of stringObj.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" end")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"small"}})]),t._v(" "),r("h2",{attrs:{id:"small"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#small","aria-hidden":"true"}},[t._v("#")]),t._v(" small")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("small")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.small")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:484")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"split"}})]),t._v(" "),r("h2",{attrs:{id:"split"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#split","aria-hidden":"true"}},[t._v("#")]),t._v(" split")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("split")]),t._v("(separator: "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(", limit?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")]),t._v("[]")]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.split")])]),t._v(" "),r("p",[r("em",[t._v("Overrides String.split")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:475")])]),t._v(" "),r("p",[t._v("Split a string into substrings using the specified separator and return them as an array.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("separator")]),t._v(" "),r("td",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("RegExp")])]),t._v(" "),r("td",[t._v("A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" limit")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("A value used to limit the number of elements returned in the array.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")]),t._v("[]")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"startswith"}})]),t._v(" "),r("h2",{attrs:{id:"startswith"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#startswith","aria-hidden":"true"}},[t._v("#")]),t._v(" startsWith")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("startsWith")]),t._v("(searchString: "),r("em",[r("code",[t._v("string")])]),t._v(", position?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.startsWith")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:448")])]),t._v(" "),r("p",[t._v("Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("searchString")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" position")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"strike"}})]),t._v(" "),r("h2",{attrs:{id:"strike"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#strike","aria-hidden":"true"}},[t._v("#")]),t._v(" strike")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("strike")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.strike")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:487")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sub"}})]),t._v(" "),r("h2",{attrs:{id:"sub"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[t._v("#")]),t._v(" sub")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sub")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.sub")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:490")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"substr"}})]),t._v(" "),r("h2",{attrs:{id:"substr"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#substr","aria-hidden":"true"}},[t._v("#")]),t._v(" substr")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("substr")]),t._v("(from: "),r("em",[r("code",[t._v("number")])]),t._v(", length?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.substr")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:509")])]),t._v(" "),r("p",[t._v("Gets a substring beginning at the specified location and having the specified length.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("from")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The starting position of the desired substring. The index of the first character in the string is zero.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" length")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The number of characters to include in the returned substring.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"substring"}})]),t._v(" "),r("h2",{attrs:{id:"substring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#substring","aria-hidden":"true"}},[t._v("#")]),t._v(" substring")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("substring")]),t._v("(start: "),r("em",[r("code",[t._v("number")])]),t._v(", end?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.substring")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:483")])]),t._v(" "),r("p",[t._v("Returns the substring at the specified location within a String object.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("start")]),t._v(" "),r("td",[r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("The zero-based index number indicating the beginning of the substring.")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" end")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("number")])]),t._v(" "),r("td",[t._v("Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sup"}})]),t._v(" "),r("h2",{attrs:{id:"sup"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sup","aria-hidden":"true"}},[t._v("#")]),t._v(" sup")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sup")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.sup")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:493")])]),t._v(" "),r("p",[t._v("Returns a HTML element")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:83"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tolocalelowercase"}})]),t._v(" "),r("h2",{attrs:{id:"tolocalelowercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalelowercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toLocaleLowerCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toLocaleLowerCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toLocaleLowerCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:489")])]),t._v(" "),r("p",[t._v("Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tolocaleuppercase"}})]),t._v(" "),r("h2",{attrs:{id:"tolocaleuppercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocaleuppercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toLocaleUpperCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toLocaleUpperCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toLocaleUpperCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:495")])]),t._v(" "),r("p",[t._v("Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tolowercase"}})]),t._v(" "),r("h2",{attrs:{id:"tolowercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolowercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toLowerCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toLowerCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toLowerCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:486")])]),t._v(" "),r("p",[t._v("Converts all the alphabetic characters in a string to lowercase.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides String.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Text.ts:90"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Type.ts:87"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"touppercase"}})]),t._v(" "),r("h2",{attrs:{id:"touppercase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#touppercase","aria-hidden":"true"}},[t._v("#")]),t._v(" toUpperCase")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toUpperCase")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.toUpperCase")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:492")])]),t._v(" "),r("p",[t._v("Converts all the alphabetic characters in a string to uppercase.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"trim"}})]),t._v(" "),r("h2",{attrs:{id:"trim"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#trim","aria-hidden":"true"}},[t._v("#")]),t._v(" trim")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("trim")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.trim")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:498")])]),t._v(" "),r("p",[t._v("Removes the leading and trailing white space and line terminator characters from a string.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"trimleft"}})]),t._v(" "),r("h2",{attrs:{id:"trimleft"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#trimleft","aria-hidden":"true"}},[t._v("#")]),t._v(" trimLeft")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("trimLeft")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.trimLeft")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:152")])]),t._v(" "),r("p",[t._v("Removes whitespace from the left end of a string.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"trimright"}})]),t._v(" "),r("h2",{attrs:{id:"trimright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#trimright","aria-hidden":"true"}},[t._v("#")]),t._v(" trimRight")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("trimRight")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.trimRight")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:154")])]),t._v(" "),r("p",[t._v("Removes whitespace from the right end of a string.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"valueof"}})]),t._v(" "),r("h2",{attrs:{id:"valueof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#valueof","aria-hidden":"true"}},[t._v("#")]),t._v(" valueOf")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("valueOf")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from String.valueOf")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:512")])]),t._v(" "),r("p",[t._v("Returns the primitive value of the specified object.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/211.1efecaad.js b/docs/assets/js/211.1efecaad.js deleted file mode 100644 index 333879c0c1..0000000000 --- a/docs/assets/js/211.1efecaad.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[211],{359:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": U128")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 128-bit unsigned integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ U128")])]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")])],1),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new U128")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U128.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/212.5126bb85.js b/docs/assets/js/212.5126bb85.js deleted file mode 100644 index 14eee178c8..0000000000 --- a/docs/assets/js/212.5126bb85.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[212],{356:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": U16")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 16-bit unsigned integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ U16")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new U16")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[e._v("U16")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U16.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U16.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[e._v("U16")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/213.cf3debe0.js b/docs/assets/js/213.cf3debe0.js deleted file mode 100644 index 7d5e604bf3..0000000000 --- a/docs/assets/js/213.cf3debe0.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[213],{353:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": U256")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 256-bit unsigned integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ U256")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new U256")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[e._v("U256")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U256.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U256.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[e._v("U256")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/214.a852db4b.js b/docs/assets/js/214.a852db4b.js deleted file mode 100644 index 79a8d42224..0000000000 --- a/docs/assets/js/214.a852db4b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[214],{350:function(e,t,_){"use strict";_.r(t);var v=_(46),r=Object(v.a)({},function(){var e=this,t=e.$createElement,_=e._self._c||t;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("p",[_("em",[_("strong",[e._v("name")])]),e._v(": U32")]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": An 32-bit unsigned integer")]),e._v(" "),_("h1",{attrs:{id:"hierarchy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")])],1),e._v(" "),_("p",[_("strong",[e._v("↳ U32")])]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[e._v("MagicNumber")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[e._v("AccountIndex")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[e._v("ParaId")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[e._v("ApplyExtrinsic")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[e._v("Permill")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[e._v("Perbill")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[e._v("PropIndex")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[e._v("ProposalIndex")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[e._v("ReferendumIndex")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[e._v("VoteIndex")])],1),e._v(" "),_("h1",{attrs:{id:"implements"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),_("h1",{attrs:{id:"constructors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),_("p",[_("a",{attrs:{id:"constructor"}})]),e._v(" "),_("h2",{attrs:{id:"constructor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),_("p",[e._v("⊕ "),_("strong",[e._v("new U32")]),e._v("(value?: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),_("p",[_("em",[e._v("Overrides "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"accessors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),_("p",[_("a",{attrs:{id:"encodedlength"}})]),e._v(" "),_("h2",{attrs:{id:"encodedlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),_("p",[_("strong",[e._v("get encodedLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isempty"}})]),e._v(" "),_("h2",{attrs:{id:"isempty"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),_("p",[_("strong",[e._v("get isEmpty")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"methods"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),_("p",[_("a",{attrs:{id:"abs"}})]),e._v(" "),_("h2",{attrs:{id:"abs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("abs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.abs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"add"}})]),e._v(" "),_("h2",{attrs:{id:"add"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("add")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.add")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"addn"}})]),e._v(" "),_("h2",{attrs:{id:"addn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("addn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.addn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"and"}})]),e._v(" "),_("h2",{attrs:{id:"and"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("and")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.and")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"andln"}})]),e._v(" "),_("h2",{attrs:{id:"andln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("andln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.andln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and (NOTE: "),_("code",[e._v("andln")]),e._v(" is going to be replaced with "),_("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bincn"}})]),e._v(" "),_("h2",{attrs:{id:"bincn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bincn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": add "),_("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bitlength"}})]),e._v(" "),_("h2",{attrs:{id:"bitlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bitLength")]),e._v("(): "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bytelength"}})]),e._v(" "),_("h2",{attrs:{id:"bytelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("byteLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"clone"}})]),e._v(" "),_("h2",{attrs:{id:"clone"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("clone")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.clone")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmp"}})]),e._v(" "),_("h2",{attrs:{id:"cmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmpn"}})]),e._v(" "),_("h2",{attrs:{id:"cmpn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmpn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"div"}})]),e._v(" "),_("h2",{attrs:{id:"div"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("div")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.div")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divround"}})]),e._v(" "),_("h2",{attrs:{id:"divround"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divRound")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divn"}})]),e._v(" "),_("h2",{attrs:{id:"divn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"egcd"}})]),e._v(" "),_("h2",{attrs:{id:"egcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("egcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("object")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Extended GCD results "),_("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("object")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eq"}})]),e._v(" "),_("h2",{attrs:{id:"eq"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eq")]),e._v("(other?: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.eq")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eqn"}})]),e._v(" "),_("h2",{attrs:{id:"eqn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eqn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"fromtwos"}})]),e._v(" "),_("h2",{attrs:{id:"fromtwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("fromTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gcd"}})]),e._v(" "),_("h2",{attrs:{id:"gcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gt"}})]),e._v(" "),_("h2",{attrs:{id:"gt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gte"}})]),e._v(" "),_("h2",{attrs:{id:"gte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gten"}})]),e._v(" "),_("h2",{attrs:{id:"gten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gtn"}})]),e._v(" "),_("h2",{attrs:{id:"gtn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gtn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iabs"}})]),e._v(" "),_("h2",{attrs:{id:"iabs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iabs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iadd"}})]),e._v(" "),_("h2",{attrs:{id:"iadd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iadd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iaddn"}})]),e._v(" "),_("h2",{attrs:{id:"iaddn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iaddn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iand"}})]),e._v(" "),_("h2",{attrs:{id:"iand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"idivn"}})]),e._v(" "),_("h2",{attrs:{id:"idivn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("idivn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imaskn"}})]),e._v(" "),_("h2",{attrs:{id:"imaskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imaskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imul"}})]),e._v(" "),_("h2",{attrs:{id:"imul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imuln"}})]),e._v(" "),_("h2",{attrs:{id:"imuln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imuln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ineg"}})]),e._v(" "),_("h2",{attrs:{id:"ineg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ineg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"inotn"}})]),e._v(" "),_("h2",{attrs:{id:"inotn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("inotn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"invm"}})]),e._v(" "),_("h2",{attrs:{id:"invm"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("invm")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.invm")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": inverse "),_("code",[e._v("a")]),e._v(" modulo "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ior"}})]),e._v(" "),_("h2",{attrs:{id:"ior"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ior")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ior")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iseven"}})]),e._v(" "),_("h2",{attrs:{id:"iseven"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isEven")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isneg"}})]),e._v(" "),_("h2",{attrs:{id:"isneg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isNeg")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isodd"}})]),e._v(" "),_("h2",{attrs:{id:"isodd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isOdd")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iszero"}})]),e._v(" "),_("h2",{attrs:{id:"iszero"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isZero")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishln"}})]),e._v(" "),_("h2",{attrs:{id:"ishln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishrn"}})]),e._v(" "),_("h2",{attrs:{id:"ishrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),_("OutboundLink")],1),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isqr"}})]),e._v(" "),_("h2",{attrs:{id:"isqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isub"}})]),e._v(" "),_("h2",{attrs:{id:"isub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isubn"}})]),e._v(" "),_("h2",{attrs:{id:"isubn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isubn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuand"}})]),e._v(" "),_("h2",{attrs:{id:"iuand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuor"}})]),e._v(" "),_("h2",{attrs:{id:"iuor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushln"}})]),e._v(" "),_("h2",{attrs:{id:"iushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushrn"}})]),e._v(" "),_("h2",{attrs:{id:"iushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuxor"}})]),e._v(" "),_("h2",{attrs:{id:"iuxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ixor"}})]),e._v(" "),_("h2",{attrs:{id:"ixor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ixor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lt"}})]),e._v(" "),_("h2",{attrs:{id:"lt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lte"}})]),e._v(" "),_("h2",{attrs:{id:"lte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lten"}})]),e._v(" "),_("h2",{attrs:{id:"lten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ltn"}})]),e._v(" "),_("h2",{attrs:{id:"ltn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ltn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"maskn"}})]),e._v(" "),_("h2",{attrs:{id:"maskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("maskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mod"}})]),e._v(" "),_("h2",{attrs:{id:"mod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"modn"}})]),e._v(" "),_("h2",{attrs:{id:"modn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("modn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.modn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("see")])]),e._v(": API consistency "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),_("OutboundLink")],1)]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mul"}})]),e._v(" "),_("h2",{attrs:{id:"mul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"muln"}})]),e._v(" "),_("h2",{attrs:{id:"muln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("muln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.muln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"neg"}})]),e._v(" "),_("h2",{attrs:{id:"neg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("neg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.neg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"notn"}})]),e._v(" "),_("h2",{attrs:{id:"notn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("notn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.notn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"or"}})]),e._v(" "),_("h2",{attrs:{id:"or"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("or")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.or")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"pow"}})]),e._v(" "),_("h2",{attrs:{id:"pow"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("pow")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.pow")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": raise "),_("code",[e._v("a")]),e._v(" to the power of "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"setn"}})]),e._v(" "),_("h2",{attrs:{id:"setn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("setn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.setn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shln"}})]),e._v(" "),_("h2",{attrs:{id:"shln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shrn"}})]),e._v(" "),_("h2",{attrs:{id:"shrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sqr"}})]),e._v(" "),_("h2",{attrs:{id:"sqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sub"}})]),e._v(" "),_("h2",{attrs:{id:"sub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"subn"}})]),e._v(" "),_("h2",{attrs:{id:"subn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("subn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.subn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"testn"}})]),e._v(" "),_("h2",{attrs:{id:"testn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("testn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.testn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarray"}})]),e._v(" "),_("h2",{attrs:{id:"toarray"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArray")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarraylike"}})]),e._v(" "),_("h2",{attrs:{id:"toarraylike"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("object")])]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to an instance of "),_("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("object")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("any")]),e._v("[]")])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobn"}})]),e._v(" "),_("h2",{attrs:{id:"tobn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBn")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobuffer"}})]),e._v(" "),_("h2",{attrs:{id:"tobuffer"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBuffer")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tohex"}})]),e._v(" "),_("h2",{attrs:{id:"tohex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toHex")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tojson"}})]),e._v(" "),_("h2",{attrs:{id:"tojson"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toJSON")]),e._v("(): "),_("code",[e._v("any")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tonumber"}})]),e._v(" "),_("h2",{attrs:{id:"tonumber"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toNumber")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tored"}})]),e._v(" "),_("h2",{attrs:{id:"tored"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toRed")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("ReductionContext")])]),e._v("): "),_("code",[e._v("RedBN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("ReductionContext")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("RedBN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tostring"}})]),e._v(" "),_("h2",{attrs:{id:"tostring"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toString")]),e._v("(base?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toString")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v(" "),_("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"totwos"}})]),e._v(" "),_("h2",{attrs:{id:"totwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tou8a"}})]),e._v(" "),_("h2",{attrs:{id:"tou8a"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toU8a")]),e._v("(isBare?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v(" "),_("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uand"}})]),e._v(" "),_("h2",{attrs:{id:"uand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ucmp"}})]),e._v(" "),_("h2",{attrs:{id:"ucmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ucmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"umod"}})]),e._v(" "),_("h2",{attrs:{id:"umod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("umod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.umod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uor"}})]),e._v(" "),_("h2",{attrs:{id:"uor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushln"}})]),e._v(" "),_("h2",{attrs:{id:"ushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushrn"}})]),e._v(" "),_("h2",{attrs:{id:"ushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uxor"}})]),e._v(" "),_("h2",{attrs:{id:"uxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"xor"}})]),e._v(" "),_("h2",{attrs:{id:"xor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("xor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.xor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"zerobits"}})]),e._v(" "),_("h2",{attrs:{id:"zerobits"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("zeroBits")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeabstracint"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),_("em",[_("code",[e._v("boolean")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),_("tr",[_("td",[e._v("bitLength")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),_("tr",[_("td",[e._v("isNegative")]),e._v(" "),_("td",[_("code",[e._v("boolean")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isbn"}})]),e._v(" "),_("h2",{attrs:{id:"static-isbn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" isBN")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isBN")]),e._v("(b: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"max"}})]),e._v(" "),_("h2",{attrs:{id:"static-max"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" max")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("max")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.max")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"min"}})]),e._v(" "),_("h2",{attrs:{id:"static-min"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" min")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("min")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.min")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mont"}})]),e._v(" "),_("h2",{attrs:{id:"static-mont"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" mont")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mont")]),e._v("(num: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mont")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("num")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"red"}})]),e._v(" "),_("h2",{attrs:{id:"static-red"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" red")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("red")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.red")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/215.958e2264.js b/docs/assets/js/215.958e2264.js deleted file mode 100644 index e32dd0f859..0000000000 --- a/docs/assets/js/215.958e2264.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[215],{347:function(e,t,_){"use strict";_.r(t);var v=_(46),r=Object(v.a)({},function(){var e=this,t=e.$createElement,_=e._self._c||t;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("p",[_("em",[_("strong",[e._v("name")])]),e._v(": U64")]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": An 64-bit unsigned integer")]),e._v(" "),_("h1",{attrs:{id:"hierarchy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")])],1),e._v(" "),_("p",[_("strong",[e._v("↳ U64")])]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[e._v("USize")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[e._v("BlockNumber")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[e._v("Nonce")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[e._v("Gas")])],1),e._v(" "),_("h1",{attrs:{id:"implements"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),_("h1",{attrs:{id:"constructors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),_("p",[_("a",{attrs:{id:"constructor"}})]),e._v(" "),_("h2",{attrs:{id:"constructor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),_("p",[e._v("⊕ "),_("strong",[e._v("new U64")]),e._v("(value?: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),_("p",[_("em",[e._v("Overrides "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U64.ts:14"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"accessors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),_("p",[_("a",{attrs:{id:"encodedlength"}})]),e._v(" "),_("h2",{attrs:{id:"encodedlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),_("p",[_("strong",[e._v("get encodedLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isempty"}})]),e._v(" "),_("h2",{attrs:{id:"isempty"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),_("p",[_("strong",[e._v("get isEmpty")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"methods"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),_("p",[_("a",{attrs:{id:"abs"}})]),e._v(" "),_("h2",{attrs:{id:"abs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("abs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.abs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"add"}})]),e._v(" "),_("h2",{attrs:{id:"add"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("add")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.add")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"addn"}})]),e._v(" "),_("h2",{attrs:{id:"addn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("addn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.addn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"and"}})]),e._v(" "),_("h2",{attrs:{id:"and"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("and")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.and")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"andln"}})]),e._v(" "),_("h2",{attrs:{id:"andln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("andln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.andln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and (NOTE: "),_("code",[e._v("andln")]),e._v(" is going to be replaced with "),_("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bincn"}})]),e._v(" "),_("h2",{attrs:{id:"bincn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bincn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": add "),_("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bitlength"}})]),e._v(" "),_("h2",{attrs:{id:"bitlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bitLength")]),e._v("(): "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bytelength"}})]),e._v(" "),_("h2",{attrs:{id:"bytelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("byteLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"clone"}})]),e._v(" "),_("h2",{attrs:{id:"clone"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("clone")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.clone")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmp"}})]),e._v(" "),_("h2",{attrs:{id:"cmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmpn"}})]),e._v(" "),_("h2",{attrs:{id:"cmpn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmpn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"div"}})]),e._v(" "),_("h2",{attrs:{id:"div"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("div")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.div")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divround"}})]),e._v(" "),_("h2",{attrs:{id:"divround"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divRound")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divn"}})]),e._v(" "),_("h2",{attrs:{id:"divn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"egcd"}})]),e._v(" "),_("h2",{attrs:{id:"egcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("egcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("object")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Extended GCD results "),_("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("object")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eq"}})]),e._v(" "),_("h2",{attrs:{id:"eq"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eq")]),e._v("(other?: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.eq")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eqn"}})]),e._v(" "),_("h2",{attrs:{id:"eqn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eqn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"fromtwos"}})]),e._v(" "),_("h2",{attrs:{id:"fromtwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("fromTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gcd"}})]),e._v(" "),_("h2",{attrs:{id:"gcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gt"}})]),e._v(" "),_("h2",{attrs:{id:"gt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gte"}})]),e._v(" "),_("h2",{attrs:{id:"gte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gten"}})]),e._v(" "),_("h2",{attrs:{id:"gten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gtn"}})]),e._v(" "),_("h2",{attrs:{id:"gtn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gtn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iabs"}})]),e._v(" "),_("h2",{attrs:{id:"iabs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iabs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iadd"}})]),e._v(" "),_("h2",{attrs:{id:"iadd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iadd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iaddn"}})]),e._v(" "),_("h2",{attrs:{id:"iaddn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iaddn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iand"}})]),e._v(" "),_("h2",{attrs:{id:"iand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"idivn"}})]),e._v(" "),_("h2",{attrs:{id:"idivn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("idivn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imaskn"}})]),e._v(" "),_("h2",{attrs:{id:"imaskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imaskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imul"}})]),e._v(" "),_("h2",{attrs:{id:"imul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imuln"}})]),e._v(" "),_("h2",{attrs:{id:"imuln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imuln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ineg"}})]),e._v(" "),_("h2",{attrs:{id:"ineg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ineg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"inotn"}})]),e._v(" "),_("h2",{attrs:{id:"inotn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("inotn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"invm"}})]),e._v(" "),_("h2",{attrs:{id:"invm"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("invm")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.invm")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": inverse "),_("code",[e._v("a")]),e._v(" modulo "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ior"}})]),e._v(" "),_("h2",{attrs:{id:"ior"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ior")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ior")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iseven"}})]),e._v(" "),_("h2",{attrs:{id:"iseven"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isEven")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isneg"}})]),e._v(" "),_("h2",{attrs:{id:"isneg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isNeg")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isodd"}})]),e._v(" "),_("h2",{attrs:{id:"isodd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isOdd")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iszero"}})]),e._v(" "),_("h2",{attrs:{id:"iszero"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isZero")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishln"}})]),e._v(" "),_("h2",{attrs:{id:"ishln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishrn"}})]),e._v(" "),_("h2",{attrs:{id:"ishrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),_("OutboundLink")],1),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isqr"}})]),e._v(" "),_("h2",{attrs:{id:"isqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isub"}})]),e._v(" "),_("h2",{attrs:{id:"isub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isubn"}})]),e._v(" "),_("h2",{attrs:{id:"isubn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isubn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuand"}})]),e._v(" "),_("h2",{attrs:{id:"iuand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuor"}})]),e._v(" "),_("h2",{attrs:{id:"iuor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushln"}})]),e._v(" "),_("h2",{attrs:{id:"iushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushrn"}})]),e._v(" "),_("h2",{attrs:{id:"iushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuxor"}})]),e._v(" "),_("h2",{attrs:{id:"iuxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ixor"}})]),e._v(" "),_("h2",{attrs:{id:"ixor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ixor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lt"}})]),e._v(" "),_("h2",{attrs:{id:"lt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lte"}})]),e._v(" "),_("h2",{attrs:{id:"lte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lten"}})]),e._v(" "),_("h2",{attrs:{id:"lten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ltn"}})]),e._v(" "),_("h2",{attrs:{id:"ltn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ltn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"maskn"}})]),e._v(" "),_("h2",{attrs:{id:"maskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("maskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mod"}})]),e._v(" "),_("h2",{attrs:{id:"mod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"modn"}})]),e._v(" "),_("h2",{attrs:{id:"modn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("modn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.modn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("see")])]),e._v(": API consistency "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),_("OutboundLink")],1)]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mul"}})]),e._v(" "),_("h2",{attrs:{id:"mul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"muln"}})]),e._v(" "),_("h2",{attrs:{id:"muln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("muln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.muln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"neg"}})]),e._v(" "),_("h2",{attrs:{id:"neg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("neg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.neg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"notn"}})]),e._v(" "),_("h2",{attrs:{id:"notn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("notn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.notn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"or"}})]),e._v(" "),_("h2",{attrs:{id:"or"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("or")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.or")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"pow"}})]),e._v(" "),_("h2",{attrs:{id:"pow"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("pow")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.pow")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": raise "),_("code",[e._v("a")]),e._v(" to the power of "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"setn"}})]),e._v(" "),_("h2",{attrs:{id:"setn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("setn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.setn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shln"}})]),e._v(" "),_("h2",{attrs:{id:"shln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shrn"}})]),e._v(" "),_("h2",{attrs:{id:"shrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sqr"}})]),e._v(" "),_("h2",{attrs:{id:"sqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sub"}})]),e._v(" "),_("h2",{attrs:{id:"sub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"subn"}})]),e._v(" "),_("h2",{attrs:{id:"subn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("subn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.subn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"testn"}})]),e._v(" "),_("h2",{attrs:{id:"testn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("testn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.testn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarray"}})]),e._v(" "),_("h2",{attrs:{id:"toarray"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArray")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarraylike"}})]),e._v(" "),_("h2",{attrs:{id:"toarraylike"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("object")])]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to an instance of "),_("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("object")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("any")]),e._v("[]")])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobn"}})]),e._v(" "),_("h2",{attrs:{id:"tobn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBn")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobuffer"}})]),e._v(" "),_("h2",{attrs:{id:"tobuffer"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBuffer")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tohex"}})]),e._v(" "),_("h2",{attrs:{id:"tohex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toHex")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tojson"}})]),e._v(" "),_("h2",{attrs:{id:"tojson"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toJSON")]),e._v("(): "),_("code",[e._v("any")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tonumber"}})]),e._v(" "),_("h2",{attrs:{id:"tonumber"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toNumber")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tored"}})]),e._v(" "),_("h2",{attrs:{id:"tored"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toRed")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("ReductionContext")])]),e._v("): "),_("code",[e._v("RedBN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("ReductionContext")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("RedBN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tostring"}})]),e._v(" "),_("h2",{attrs:{id:"tostring"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toString")]),e._v("(base?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toString")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v(" "),_("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"totwos"}})]),e._v(" "),_("h2",{attrs:{id:"totwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tou8a"}})]),e._v(" "),_("h2",{attrs:{id:"tou8a"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toU8a")]),e._v("(isBare?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v(" "),_("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uand"}})]),e._v(" "),_("h2",{attrs:{id:"uand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ucmp"}})]),e._v(" "),_("h2",{attrs:{id:"ucmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ucmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"umod"}})]),e._v(" "),_("h2",{attrs:{id:"umod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("umod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.umod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uor"}})]),e._v(" "),_("h2",{attrs:{id:"uor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushln"}})]),e._v(" "),_("h2",{attrs:{id:"ushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushrn"}})]),e._v(" "),_("h2",{attrs:{id:"ushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uxor"}})]),e._v(" "),_("h2",{attrs:{id:"uxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"xor"}})]),e._v(" "),_("h2",{attrs:{id:"xor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("xor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.xor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"zerobits"}})]),e._v(" "),_("h2",{attrs:{id:"zerobits"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("zeroBits")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeabstracint"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),_("em",[_("code",[e._v("boolean")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),_("tr",[_("td",[e._v("bitLength")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),_("tr",[_("td",[e._v("isNegative")]),e._v(" "),_("td",[_("code",[e._v("boolean")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isbn"}})]),e._v(" "),_("h2",{attrs:{id:"static-isbn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" isBN")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isBN")]),e._v("(b: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"max"}})]),e._v(" "),_("h2",{attrs:{id:"static-max"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" max")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("max")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.max")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"min"}})]),e._v(" "),_("h2",{attrs:{id:"static-min"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" min")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("min")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.min")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mont"}})]),e._v(" "),_("h2",{attrs:{id:"static-mont"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" mont")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mont")]),e._v("(num: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mont")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("num")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"red"}})]),e._v(" "),_("h2",{attrs:{id:"static-red"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" red")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("red")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.red")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/216.96259efd.js b/docs/assets/js/216.96259efd.js deleted file mode 100644 index 111deec3e0..0000000000 --- a/docs/assets/js/216.96259efd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[216],{344:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": U8")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An 8-bit unsigned integer")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ U8")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new U8")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[e._v("U8")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U8.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U8.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[e._v("U8")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/217.814d497f.js b/docs/assets/js/217.814d497f.js deleted file mode 100644 index 55255c7451..0000000000 --- a/docs/assets/js/217.814d497f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[217],{341:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": USize")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": A System default unsigned number, typically used in RPC to report non-consensus data. It is a wrapper for "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")]),e._v(" as a 64-binary default")],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ USize")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new USize")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[e._v("USize")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U64.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[e._v("USize")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/218.2b543c38.js b/docs/assets/js/218.2b543c38.js deleted file mode 100644 index 3acdc435c4..0000000000 --- a/docs/assets/js/218.2b543c38.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[218],{616:function(e,t,r){"use strict";r.r(t);var s=r(46),_=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": ChainProperties")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Wraps the properties retrieved from the chain via the "),r("code",[e._v("system.properties")]),e._v(" RPC call.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ChainProperties")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ChainProperties")]),e._v("(value?: "),r("em",[r("code",[e._v("object")]),e._v(" | "),r("code",[e._v("null")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_chainproperties_.chainproperties.html"}},[e._v("ChainProperties")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("object")]),e._v(" | "),r("code",[e._v("null")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_chainproperties_.chainproperties.html"}},[e._v("ChainProperties")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[r("code",[e._v("string")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),e._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[e._v("#")]),e._v(" size")]),e._v(" "),r("p",[r("strong",[e._v("● size")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.size")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:28"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Always 0, never encodes as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:35"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tokendecimals"}})]),e._v(" "),r("h2",{attrs:{id:"tokendecimals"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tokendecimals","aria-hidden":"true"}},[e._v("#")]),e._v(" tokenDecimals")]),e._v(" "),r("p",[r("strong",[e._v("get tokenDecimals")]),e._v("(): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ChainProperties.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/ChainProperties.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The token decimals, if defined (de-facto standard only)")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tokensymbol"}})]),e._v(" "),r("h2",{attrs:{id:"tokensymbol"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tokensymbol","aria-hidden":"true"}},[e._v("#")]),e._v(" tokenSymbol")]),e._v(" "),r("p",[r("strong",[e._v("get tokenSymbol")]),e._v("(): "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ChainProperties.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/ChainProperties.ts:23"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The token system, if defined (de-facto standard only)")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("string")]),e._v(", "),r("code",[e._v("any")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),e._v(" "),r("p",[e._v("Returns an iterable of entries in the map.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("string")]),e._v(", "),r("code",[e._v("any")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),e._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[e._v("#")]),e._v(" clear")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("clear")]),e._v("(): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.clear")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),e._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[e._v("#")]),e._v(" delete")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("delete")]),e._v("(key: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.delete")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("string")]),e._v(", "),r("code",[e._v("any")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the map.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("string")]),e._v(", "),r("code",[e._v("any")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),e._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[e._v("#")]),e._v(" get")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("get")]),e._v("(key: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("any")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.get")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:25")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),e._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[e._v("#")]),e._v(" has")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("has")]),e._v("(key: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.has")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(key: "),r("em",[r("code",[e._v("string")])]),e._v(", value: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("key")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:49"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Unimplemented, will throw")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:56"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:67"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[e._v("Json")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/Json.ts:74"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Unimplemented, will throw")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Map.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the map")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("any")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/219.cac05f6f.js b/docs/assets/js/219.cac05f6f.js deleted file mode 100644 index f4bf9bca9a..0000000000 --- a/docs/assets/js/219.cac05f6f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[219],{338:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Broadcast")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[e._v("ExtrinsicStatus")]),e._v(" indicating that the "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[e._v("Extrinsic")]),e._v(" has been boradcast to peers")],1),e._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"t-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Broadcast")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("T")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Broadcast")]),e._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[e._v("Broadcast")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v(" "),r("td",[e._v("[] as Array")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[e._v("Broadcast")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" Type")]),e._v(" "),r("p",[r("strong",[e._v("get Type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#type"}},[e._v("Type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:66"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The type for the items")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:82"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:90"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("T")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:173"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-t"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-t","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(_other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#indexof"}},[e._v("indexOf")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:97"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Finds the index of the value in the array")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" _other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:182"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:115"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:122"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:129"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:138"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:151"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodevector"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodevector"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodevector","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeVector")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeVector")]),e._v("<"),r("code",[e._v("T")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#decodevector"}},[e._v("decodeVector")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"t-codec-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec-2","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1)]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("O")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"o-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" O : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/22.a7728bb5.js b/docs/assets/js/22.a7728bb5.js deleted file mode 100644 index 99b28b013e..0000000000 --- a/docs/assets/js/22.a7728bb5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{354:function(t,a,e){"use strict";e.r(a);var n=e(46),r=Object(n.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"votingbalance"}})]),t._v(" "),e("h2",{attrs:{id:"votingbalance"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#votingbalance","aria-hidden":"true"}},[t._v("#")]),t._v(" votingBalance")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("votingBalance")]),t._v("(api: "),e("em",[e("code",[t._v("ApiInterface$Rx")])]),t._v("): "),e("code",[t._v("(Anonymous function)")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/votingBalance.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("balances/votingBalance.ts:16"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("api")]),t._v(" "),e("td",[e("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("(Anonymous function)")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/220.ba0f1b57.js b/docs/assets/js/220.ba0f1b57.js deleted file mode 100644 index 4b5d3d62ff..0000000000 --- a/docs/assets/js/220.ba0f1b57.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[220],{551:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Dropped")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": An "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")]),t._v(" indicating that the "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")]),t._v(" has been dropped")],1),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Dropped")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/221.69960261.js b/docs/assets/js/221.69960261.js deleted file mode 100644 index 5803a94b3f..0000000000 --- a/docs/assets/js/221.69960261.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[221],{613:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": ExtrinsicStatus")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": An "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v(" that indicates the status of the "),s("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")]),t._v(" as been submitted")],1),t._v(" "),s("h1",{attrs:{id:"hierarchy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),s("p",[t._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("<"),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")]),t._v(" | "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")]),t._v(" | "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[t._v("Finalised")]),t._v(" | "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[t._v("Usurped")]),t._v(" | "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")]),t._v(" | "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")]),t._v(" | "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")]),t._v(">")],1),t._v(" "),s("p",[s("strong",[t._v("↳ ExtrinsicStatus")])]),t._v(" "),s("h1",{attrs:{id:"implements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),s("h1",{attrs:{id:"constructors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),s("p",[s("a",{attrs:{id:"constructor"}})]),t._v(" "),s("h2",{attrs:{id:"constructor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),s("p",[t._v("⊕ "),s("strong",[t._v("new ExtrinsicStatus")]),t._v("(value: "),s("em",[s("code",[t._v("any")])]),t._v(", index?: "),s("em",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("number")])]),t._v("): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")])],1),t._v(" "),s("p",[s("em",[t._v("Overrides "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:72"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("value")]),t._v(" "),s("td",[s("code",[t._v("any")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" index")]),t._v(" "),s("td",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("number")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")])],1),t._v(" "),s("hr"),t._v(" "),s("h1",{attrs:{id:"accessors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),s("p",[s("a",{attrs:{id:"asbroadcast"}})]),t._v(" "),s("h2",{attrs:{id:"asbroadcast"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asbroadcast","aria-hidden":"true"}},[t._v("#")]),t._v(" asBroadcast")]),t._v(" "),s("p",[s("strong",[t._v("get asBroadcast")]),t._v("(): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:88"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")])],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"asdropped"}})]),t._v(" "),s("h2",{attrs:{id:"asdropped"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asdropped","aria-hidden":"true"}},[t._v("#")]),t._v(" asDropped")]),t._v(" "),s("p",[s("strong",[t._v("get asDropped")]),t._v("(): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L95",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:95"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")])],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"asfinalised"}})]),t._v(" "),s("h2",{attrs:{id:"asfinalised"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asfinalised","aria-hidden":"true"}},[t._v("#")]),t._v(" asFinalised")]),t._v(" "),s("p",[s("strong",[t._v("get asFinalised")]),t._v("(): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[t._v("Finalised")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:102"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[t._v("Finalised")])],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[t._v("Finalised")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"asfuture"}})]),t._v(" "),s("h2",{attrs:{id:"asfuture"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asfuture","aria-hidden":"true"}},[t._v("#")]),t._v(" asFuture")]),t._v(" "),s("p",[s("strong",[t._v("get asFuture")]),t._v("(): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L109",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:109"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")])],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"asinvalid"}})]),t._v(" "),s("h2",{attrs:{id:"asinvalid"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asinvalid","aria-hidden":"true"}},[t._v("#")]),t._v(" asInvalid")]),t._v(" "),s("p",[s("strong",[t._v("get asInvalid")]),t._v("(): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L116",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:116"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")])],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"asready"}})]),t._v(" "),s("h2",{attrs:{id:"asready"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asready","aria-hidden":"true"}},[t._v("#")]),t._v(" asReady")]),t._v(" "),s("p",[s("strong",[t._v("get asReady")]),t._v("(): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:123"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")])],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"asusurped"}})]),t._v(" "),s("h2",{attrs:{id:"asusurped"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asusurped","aria-hidden":"true"}},[t._v("#")]),t._v(" asUsurped")]),t._v(" "),s("p",[s("strong",[t._v("get asUsurped")]),t._v("(): "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[t._v("Usurped")])],1),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L130",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/ExtrinsicStatus.ts:130"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[t._v("Usurped")])],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[t._v("Usurped")])],1),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"encodedlength"}})]),t._v(" "),s("h2",{attrs:{id:"encodedlength"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),s("p",[s("strong",[t._v("get encodedLength")]),t._v("(): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:114"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"index"}})]),t._v(" "),s("h2",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" index")]),t._v(" "),s("p",[s("strong",[t._v("get index")]),t._v("(): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[t._v("index")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:121"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": The index of the metadata value")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"isempty"}})]),t._v(" "),s("h2",{attrs:{id:"isempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),s("p",[s("strong",[t._v("get isEmpty")]),t._v("(): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:128"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"isnone"}})]),t._v(" "),s("h2",{attrs:{id:"isnone"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[t._v("#")]),t._v(" isNone")]),t._v(" "),s("p",[s("strong",[t._v("get isNone")]),t._v("(): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[t._v("isNone")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:135"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks if the Enum points to a "),s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v(" type")],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"isnull"}})]),t._v(" "),s("h2",{attrs:{id:"isnull"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[t._v("#")]),t._v(" isNull")]),t._v(" "),s("p",[s("strong",[t._v("get isNull")]),t._v("(): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[t._v("isNull")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:142"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks if the Enum points to a "),s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v(" type (deprecated, use isNone)")],1),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"type"}})]),t._v(" "),s("h2",{attrs:{id:"type"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),s("p",[s("strong",[t._v("get type")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[t._v("type")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:149"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": The name of the type this enum value represents")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"value"}})]),t._v(" "),s("h2",{attrs:{id:"value"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[t._v("#")]),t._v(" value")]),t._v(" "),s("p",[s("strong",[t._v("get value")]),t._v("(): "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[t._v("value")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:156"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": The value of the enum")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),s("hr"),t._v(" "),s("h1",{attrs:{id:"methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),s("p",[s("a",{attrs:{id:"eq"}})]),t._v(" "),s("h2",{attrs:{id:"eq"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("eq")]),t._v("(other?: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[t._v("eq")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:163"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tohex"}})]),t._v(" "),s("h2",{attrs:{id:"tohex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toHex")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:176"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tojson"}})]),t._v(" "),s("h2",{attrs:{id:"tojson"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toJSON")]),t._v("(): "),s("code",[t._v("any")])]),t._v(" "),s("p",[s("em",[t._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:183"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("any")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tonumber"}})]),t._v(" "),s("h2",{attrs:{id:"tonumber"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" toNumber")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toNumber")]),t._v("(): "),s("code",[t._v("number")])]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[t._v("toNumber")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:192"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the number representation for the value")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("number")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tostring"}})]),t._v(" "),s("h2",{attrs:{id:"tostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toString")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:199"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tou8a"}})]),t._v(" "),s("h2",{attrs:{id:"tou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toU8a")]),t._v("(isBare?: "),s("em",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("false")]),t._v(" | "),s("code",[t._v("true")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:209"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),s("td",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("false")]),t._v(" | "),s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"with"}})]),t._v(" "),s("h2",{attrs:{id:"static-with"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),s("code",[t._v("")]),t._v(" with")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("with")]),t._v("<"),s("code",[t._v("S")]),t._v(">(Types: "),s("em",[s("code",[t._v("S")])]),t._v("): "),s("code",[t._v("EnumConstructor")]),t._v("<"),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("<"),s("code",[t._v("S")]),t._v(">>")],1),t._v(" "),s("p",[s("em",[t._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[t._v("with")])],1)]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:101"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Type parameters:")])]),t._v(" "),s("h4",{attrs:{id:"s-constructordef"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),s("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("Types")]),t._v(" "),s("td",[s("code",[t._v("S")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("EnumConstructor")]),t._v("<"),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("<"),s("code",[t._v("S")]),t._v(">>")],1),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/222.16028c06.js b/docs/assets/js/222.16028c06.js deleted file mode 100644 index 8973461faf..0000000000 --- a/docs/assets/js/222.16028c06.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[222],{446:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Finalised")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An [[ExtrinsicStats] indicating that the "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[e._v("Extrinsic")]),e._v("] has been finalised and included")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Finalised")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Finalised")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[e._v("Finalised")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H256.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[e._v("Finalised")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/223.e16c683c.js b/docs/assets/js/223.e16c683c.js deleted file mode 100644 index d787fdc100..0000000000 --- a/docs/assets/js/223.e16c683c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[223],{552:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Future")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": An "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")]),t._v(" indicating that the "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")]),t._v(" has been added to the future queue")],1),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Future")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/224.c038df2b.js b/docs/assets/js/224.c038df2b.js deleted file mode 100644 index e422ddc4ea..0000000000 --- a/docs/assets/js/224.c038df2b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[224],{554:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Invalid")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": An "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")]),t._v(" indicating that the "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")]),t._v(" is invalid")],1),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Invalid")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/225.7df2d9f2.js b/docs/assets/js/225.7df2d9f2.js deleted file mode 100644 index d61430815d..0000000000 --- a/docs/assets/js/225.7df2d9f2.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[225],{555:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Ready")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": An "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")]),t._v(" indicating that the "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")]),t._v(" has been added to the ready queue")],1),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Ready")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/226.4c36f1be.js b/docs/assets/js/226.4c36f1be.js deleted file mode 100644 index 6f1d45de16..0000000000 --- a/docs/assets/js/226.4c36f1be.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[226],{443:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Usurped")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[e._v("ExtrinsicStatus")]),e._v(" indicating that the "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[e._v("Extrinsic")]),e._v(" has been usurped")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Usurped")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Usurped")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[e._v("Usurped")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H256.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[e._v("Usurped")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/227.9a2401b9.js b/docs/assets/js/227.9a2401b9.js deleted file mode 100644 index a60d5b9bbe..0000000000 --- a/docs/assets/js/227.9a2401b9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[227],{610:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Health")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A system health indicator, reported back over RPC")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Health")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Health")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_health_.health.html"}},[t._v("Health")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Health.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_health_.health.html"}},[t._v("Health")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"issyncing"}})]),t._v(" "),r("h2",{attrs:{id:"issyncing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#issyncing","aria-hidden":"true"}},[t._v("#")]),t._v(" isSyncing")]),t._v(" "),r("p",[r("strong",[t._v("get isSyncing")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Health.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The sync status")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"peers"}})]),t._v(" "),r("h2",{attrs:{id:"peers"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#peers","aria-hidden":"true"}},[t._v("#")]),t._v(" peers")]),t._v(" "),r("p",[r("strong",[t._v("get peers")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Health.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The numbers of peers as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"shouldhavepeers"}})]),t._v(" "),r("h2",{attrs:{id:"shouldhavepeers"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shouldhavepeers","aria-hidden":"true"}},[t._v("#")]),t._v(" shouldHavePeers")]),t._v(" "),r("p",[r("strong",[t._v("get shouldHavePeers")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Health.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Should this node have peers (not active on --dev)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/228.1b9fb659.js b/docs/assets/js/228.1b9fb659.js deleted file mode 100644 index 04cb810046..0000000000 --- a/docs/assets/js/228.1b9fb659.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[228],{557:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Json")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it implements a Codec, it is limited in that it can only be used with input objects via RPC, i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("string")]),t._v(", "),r("code",[t._v("any")]),t._v(">")]),t._v(" "),r("p",[r("strong",[t._v("↳ Json")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_chainproperties_.chainproperties.html"}},[t._v("ChainProperties")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_networkstate_.networkstate.html"}},[t._v("NetworkState")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Json")]),t._v("(value?: "),r("em",[r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:16"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),t._v(" "),r("h2",{attrs:{id:"static-map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-map","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" Map")]),t._v(" "),r("p",[r("strong",[t._v("● Map")]),t._v(": "),r("em",[r("code",[t._v("MapConstructor")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Always 0, never encodes as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:49"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Unimplemented, will throw")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Unimplemented, will throw")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/229.1e4a771a.js b/docs/assets/js/229.1e4a771a.js deleted file mode 100644 index f95d95ac3a..0000000000 --- a/docs/assets/js/229.1e4a771a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[229],{558:function(t,e,r){"use strict";r.r(e);var _=r(46),s=Object(_.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": NetworkState")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Wraps the properties retrieved from the chain via the "),r("code",[t._v("system.network_state")]),t._v(" RPC call.")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ NetworkState")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new NetworkState")]),t._v("(value?: "),r("em",[r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("null")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_networkstate_.networkstate.html"}},[t._v("NetworkState")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:16"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("null")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_networkstate_.networkstate.html"}},[t._v("NetworkState")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Always 0, never encodes as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("string")]),t._v(", "),r("code",[t._v("any")]),t._v("]>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("string")]),t._v(", "),r("code",[t._v("any")]),t._v("]>")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("string")]),t._v(", "),r("code",[t._v("any")]),t._v("]>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("string")]),t._v(", "),r("code",[t._v("any")]),t._v("]>")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(key: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("any")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:25")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("string")])]),t._v(", value: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:49"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Unimplemented, will throw")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:56"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/Json.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Unimplemented, will throw")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("any")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("any")]),t._v(">")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/23.b30fdfff.js b/docs/assets/js/23.b30fdfff.js deleted file mode 100644 index 1aa32ff0fd..0000000000 --- a/docs/assets/js/23.b30fdfff.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{355:function(t,a,e){"use strict";e.r(a);var n=e(46),s=Object(n.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"votingbalances"}})]),t._v(" "),e("h2",{attrs:{id:"votingbalances"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#votingbalances","aria-hidden":"true"}},[t._v("#")]),t._v(" votingBalances")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("votingBalances")]),t._v("(api: "),e("em",[e("code",[t._v("ApiInterface$Rx")])]),t._v("): "),e("code",[t._v("(Anonymous function)")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/votingBalances.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("balances/votingBalances.ts:13"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("api")]),t._v(" "),e("td",[e("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("(Anonymous function)")])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/230.73c4c7fc.js b/docs/assets/js/230.73c4c7fc.js deleted file mode 100644 index 699e582bba..0000000000 --- a/docs/assets/js/230.73c4c7fc.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[230],{607:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": PeerInfo")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A system peer info indicator, reported back over RPC")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ PeerInfo")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new PeerInfo")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_peerinfo_.peerinfo.html"}},[t._v("PeerInfo")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/PeerInfo.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_peerinfo_.peerinfo.html"}},[t._v("PeerInfo")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"besthash"}})]),t._v(" "),r("h2",{attrs:{id:"besthash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#besthash","aria-hidden":"true"}},[t._v("#")]),t._v(" bestHash")]),t._v(" "),r("p",[r("strong",[t._v("get bestHash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/PeerInfo.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The best block hash for the peer")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"bestnumber"}})]),t._v(" "),r("h2",{attrs:{id:"bestnumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bestnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" bestNumber")]),t._v(" "),r("p",[r("strong",[t._v("get bestNumber")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/PeerInfo.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The best block hash for the peer")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),t._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" index")]),t._v(" "),r("p",[r("strong",[t._v("get index")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/PeerInfo.ts:53"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The index of the peer in our list")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"peerid"}})]),t._v(" "),r("h2",{attrs:{id:"peerid"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#peerid","aria-hidden":"true"}},[t._v("#")]),t._v(" peerId")]),t._v(" "),r("p",[r("strong",[t._v("get peerId")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/PeerInfo.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The p2p network id for the peer")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"protocolversion"}})]),t._v(" "),r("h2",{attrs:{id:"protocolversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#protocolversion","aria-hidden":"true"}},[t._v("#")]),t._v(" protocolVersion")]),t._v(" "),r("p",[r("strong",[t._v("get protocolVersion")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/PeerInfo.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The index of the peer in our list")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"roles"}})]),t._v(" "),r("h2",{attrs:{id:"roles"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#roles","aria-hidden":"true"}},[t._v("#")]),t._v(" roles")]),t._v(" "),r("p",[r("strong",[t._v("get roles")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/PeerInfo.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The roles of the peer on the network")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/231.e7c0d9a5.js b/docs/assets/js/231.e7c0d9a5.js deleted file mode 100644 index 57218da17d..0000000000 --- a/docs/assets/js/231.e7c0d9a5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[231],{335:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": PendingExtrinsics")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A list of pending "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[e._v("Extrinsics")])],1),e._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"t-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[e._v("Extrinsics")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ PendingExtrinsics")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("T")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new PendingExtrinsics")]),e._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html"}},[e._v("PendingExtrinsics")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v(" "),r("td",[e._v("[] as Array")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html"}},[e._v("PendingExtrinsics")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" Type")]),e._v(" "),r("p",[r("strong",[e._v("get Type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#type"}},[e._v("Type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:66"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The type for the items")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:82"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:90"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("T")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:173"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-t"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-t","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(_other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#indexof"}},[e._v("indexOf")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:97"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Finds the index of the value in the array")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" _other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:182"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:115"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:122"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:129"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:138"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:151"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodevector"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodevector"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodevector","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeVector")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeVector")]),e._v("<"),r("code",[e._v("T")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#decodevector"}},[e._v("decodeVector")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"t-codec-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec-2","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1)]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("O")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"o-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" O : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/232.5648aca5.js b/docs/assets/js/232.5648aca5.js deleted file mode 100644 index 439610f9d2..0000000000 --- a/docs/assets/js/232.5648aca5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[232],{440:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": ApiId")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An identifier for the runtime API")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ApiId")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ApiId")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[e._v("ApiId")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/RuntimeVersion.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[e._v("ApiId")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/233.b647f4f0.js b/docs/assets/js/233.b647f4f0.js deleted file mode 100644 index 6eb5c75e88..0000000000 --- a/docs/assets/js/233.b647f4f0.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[233],{604:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": RuntimeVersion")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A defintion of the runtime and the associated versions thereof")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ RuntimeVersion")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.runtimeversioninterface.html"}},[t._v("RuntimeVersionInterface")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new RuntimeVersion")]),t._v("(value?: "),r("em",[r("code",[t._v("RuntimeVersionValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/RuntimeVersion.ts:72"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("RuntimeVersionValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"apis"}})]),t._v(" "),r("h2",{attrs:{id:"apis"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#apis","aria-hidden":"true"}},[t._v("#")]),t._v(" apis")]),t._v(" "),r("p",[r("strong",[t._v("get apis")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[t._v("RuntimeVersionApi")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/RuntimeVersion.ts:93"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The available APIs as "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[t._v("RuntimeVersionApi")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[t._v("RuntimeVersionApi")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"authoringversion"}})]),t._v(" "),r("h2",{attrs:{id:"authoringversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#authoringversion","aria-hidden":"true"}},[t._v("#")]),t._v(" authoringVersion")]),t._v(" "),r("p",[r("strong",[t._v("get authoringVersion")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/RuntimeVersion.ts:100"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The authoring version as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"implname"}})]),t._v(" "),r("h2",{attrs:{id:"implname"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implname","aria-hidden":"true"}},[t._v("#")]),t._v(" implName")]),t._v(" "),r("p",[r("strong",[t._v("get implName")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/RuntimeVersion.ts:107"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The implementation name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"implversion"}})]),t._v(" "),r("h2",{attrs:{id:"implversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implversion","aria-hidden":"true"}},[t._v("#")]),t._v(" implVersion")]),t._v(" "),r("p",[r("strong",[t._v("get implVersion")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/RuntimeVersion.ts:114"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The implementation version")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"specname"}})]),t._v(" "),r("h2",{attrs:{id:"specname"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#specname","aria-hidden":"true"}},[t._v("#")]),t._v(" specName")]),t._v(" "),r("p",[r("strong",[t._v("get specName")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/RuntimeVersion.ts:121"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The specification name")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"specversion"}})]),t._v(" "),r("h2",{attrs:{id:"specversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#specversion","aria-hidden":"true"}},[t._v("#")]),t._v(" specVersion")]),t._v(" "),r("p",[r("strong",[t._v("get specVersion")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/RuntimeVersion.ts:128"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The specification version")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/234.868104fc.js b/docs/assets/js/234.868104fc.js deleted file mode 100644 index 9a2dfbc69c..0000000000 --- a/docs/assets/js/234.868104fc.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[234],{333:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": RuntimeVersionApi")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(" that conatins the "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[e._v("ApiId")]),e._v(" and "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v(" version")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ RuntimeVersionApi")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new RuntimeVersionApi")]),e._v("(value?: "),r("em",[r("code",[e._v("RuntimeVersionApiValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[e._v("RuntimeVersionApi")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/RuntimeVersion.ts:35"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("RuntimeVersionApiValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[e._v("RuntimeVersionApi")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"id"}})]),e._v(" "),r("h2",{attrs:{id:"id"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#id","aria-hidden":"true"}},[e._v("#")]),e._v(" id")]),e._v(" "),r("p",[r("strong",[e._v("get id")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[e._v("ApiId")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/RuntimeVersion.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[e._v("ApiId")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[e._v("ApiId")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"version"}})]),e._v(" "),r("h2",{attrs:{id:"version"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#version","aria-hidden":"true"}},[e._v("#")]),e._v(" version")]),e._v(" "),r("p",[r("strong",[e._v("get version")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("rpc/RuntimeVersion.ts:53"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The specific version as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/235.ecd00231.js b/docs/assets/js/235.ecd00231.js deleted file mode 100644 index 98e1e991e4..0000000000 --- a/docs/assets/js/235.ecd00231.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[235],{601:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": SignedBlock")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")]),t._v(" that has been signed and contains a "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")])],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ SignedBlock")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new SignedBlock")]),t._v("(value?: "),r("em",[r("code",[t._v("SignedBlockValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_signedblock_.signedblock.html"}},[t._v("SignedBlock")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/SignedBlock.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("SignedBlockValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_signedblock_.signedblock.html"}},[t._v("SignedBlock")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"block"}})]),t._v(" "),r("h2",{attrs:{id:"block"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#block","aria-hidden":"true"}},[t._v("#")]),t._v(" block")]),t._v(" "),r("p",[r("strong",[t._v("get block")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/SignedBlock.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),t._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),r("p",[r("strong",[t._v("get hash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/SignedBlock.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Block/header "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"justification"}})]),t._v(" "),r("h2",{attrs:{id:"justification"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#justification","aria-hidden":"true"}},[t._v("#")]),t._v(" justification")]),t._v(" "),r("p",[r("strong",[t._v("get justification")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/SignedBlock.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/236.ac517b92.js b/docs/assets/js/236.ac517b92.js deleted file mode 100644 index 708f0d66f3..0000000000 --- a/docs/assets/js/236.ac517b92.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[236],{598:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": StorageChangeSet")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A set of storage changes. It contains the "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")]),t._v(" hash and a list of the actual changes that took place as an array of "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("KeyValueOption")])],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ StorageChangeSet")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new StorageChangeSet")]),t._v("(value?: "),r("em",[r("code",[t._v("StorageChangeSetValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/StorageChangeSet.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/StorageChangeSet.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("StorageChangeSetValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"block"}})]),t._v(" "),r("h2",{attrs:{id:"block"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#block","aria-hidden":"true"}},[t._v("#")]),t._v(" block")]),t._v(" "),r("p",[r("strong",[t._v("get block")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/StorageChangeSet.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/StorageChangeSet.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The block "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"changes"}})]),t._v(" "),r("h2",{attrs:{id:"changes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#changes","aria-hidden":"true"}},[t._v("#")]),t._v(" changes")]),t._v(" "),r("p",[r("strong",[t._v("get changes")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("KeyValueOption")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/StorageChangeSet.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("rpc/StorageChangeSet.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The applicable changes as "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("KeyValueOption")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("KeyValueOption")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/237.06cb3f91.js b/docs/assets/js/237.06cb3f91.js deleted file mode 100644 index be60c9fbbb..0000000000 --- a/docs/assets/js/237.06cb3f91.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[237],{437:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": AccountId")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A wrapper around an AccountId/PublicKey representation. Since we are dealing with underlying PublicKeys (32 bytes in length), we extend from U8aFixed which is just a Uint8Array wrapper with a fixed length.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ AccountId")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountidof.html"}},[e._v("AccountIdOf")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[e._v("AuthorityId")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new AccountId")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v(" "),r("td",[e._v("new Uint8Array()")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:53"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:60"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"static-encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-encode","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/238.6cb64904.js b/docs/assets/js/238.6cb64904.js deleted file mode 100644 index df0167d5b9..0000000000 --- a/docs/assets/js/238.6cb64904.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[238],{434:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": AccountIdOf")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The Substrate AccountIdOf representation as a "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v(".")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ AccountIdOf")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new AccountIdOf")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountidof.html"}},[e._v("AccountIdOf")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v(" "),r("td",[e._v("new Uint8Array()")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountidof.html"}},[e._v("AccountIdOf")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:53"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:60"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"static-encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-encode","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#encode"}},[e._v("encode")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/239.63a6f16d.js b/docs/assets/js/239.63a6f16d.js deleted file mode 100644 index 6d7b4b1464..0000000000 --- a/docs/assets/js/239.63a6f16d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[239],{332:function(e,t,_){"use strict";_.r(t);var v=_(46),r=Object(v.a)({},function(){var e=this,t=e.$createElement,_=e._self._c||t;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("p",[_("em",[_("strong",[e._v("name")])]),e._v(": AccountIndex")]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": A wrapper around an AccountIndex, which is a shortened, variable-length encoding for an Account. We extends from "),_("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v(" to provide the number-like properties.")],1),e._v(" "),_("h1",{attrs:{id:"hierarchy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),_("p",[_("strong",[e._v("↳ AccountIndex")])]),e._v(" "),_("h1",{attrs:{id:"implements"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),_("h1",{attrs:{id:"constructors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),_("p",[_("a",{attrs:{id:"constructor"}})]),e._v(" "),_("h2",{attrs:{id:"constructor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),_("p",[e._v("⊕ "),_("strong",[e._v("new AccountIndex")]),e._v("(value?: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[e._v("AccountIndex")])],1),e._v(" "),_("p",[_("em",[e._v("Overrides "),_("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:28"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Default value")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(" "),_("td",[e._v("new BN(0)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[e._v("AccountIndex")])],1),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"accessors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),_("p",[_("a",{attrs:{id:"encodedlength"}})]),e._v(" "),_("h2",{attrs:{id:"encodedlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),_("p",[_("strong",[e._v("get encodedLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isempty"}})]),e._v(" "),_("h2",{attrs:{id:"isempty"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),_("p",[_("strong",[e._v("get isEmpty")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"methods"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),_("p",[_("a",{attrs:{id:"abs"}})]),e._v(" "),_("h2",{attrs:{id:"abs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("abs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.abs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"add"}})]),e._v(" "),_("h2",{attrs:{id:"add"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("add")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.add")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"addn"}})]),e._v(" "),_("h2",{attrs:{id:"addn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("addn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.addn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"and"}})]),e._v(" "),_("h2",{attrs:{id:"and"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("and")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.and")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"andln"}})]),e._v(" "),_("h2",{attrs:{id:"andln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("andln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.andln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and (NOTE: "),_("code",[e._v("andln")]),e._v(" is going to be replaced with "),_("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bincn"}})]),e._v(" "),_("h2",{attrs:{id:"bincn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bincn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": add "),_("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bitlength"}})]),e._v(" "),_("h2",{attrs:{id:"bitlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bitLength")]),e._v("(): "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bytelength"}})]),e._v(" "),_("h2",{attrs:{id:"bytelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("byteLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"clone"}})]),e._v(" "),_("h2",{attrs:{id:"clone"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("clone")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.clone")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmp"}})]),e._v(" "),_("h2",{attrs:{id:"cmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmpn"}})]),e._v(" "),_("h2",{attrs:{id:"cmpn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmpn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"div"}})]),e._v(" "),_("h2",{attrs:{id:"div"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("div")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.div")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divround"}})]),e._v(" "),_("h2",{attrs:{id:"divround"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divRound")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divn"}})]),e._v(" "),_("h2",{attrs:{id:"divn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"egcd"}})]),e._v(" "),_("h2",{attrs:{id:"egcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("egcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("object")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Extended GCD results "),_("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("object")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eq"}})]),e._v(" "),_("h2",{attrs:{id:"eq"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eq")]),e._v("(other?: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.eq")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:87"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eqn"}})]),e._v(" "),_("h2",{attrs:{id:"eqn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eqn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"fromtwos"}})]),e._v(" "),_("h2",{attrs:{id:"fromtwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("fromTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gcd"}})]),e._v(" "),_("h2",{attrs:{id:"gcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gt"}})]),e._v(" "),_("h2",{attrs:{id:"gt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gte"}})]),e._v(" "),_("h2",{attrs:{id:"gte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gten"}})]),e._v(" "),_("h2",{attrs:{id:"gten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gtn"}})]),e._v(" "),_("h2",{attrs:{id:"gtn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gtn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iabs"}})]),e._v(" "),_("h2",{attrs:{id:"iabs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iabs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iadd"}})]),e._v(" "),_("h2",{attrs:{id:"iadd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iadd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iaddn"}})]),e._v(" "),_("h2",{attrs:{id:"iaddn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iaddn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iand"}})]),e._v(" "),_("h2",{attrs:{id:"iand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"idivn"}})]),e._v(" "),_("h2",{attrs:{id:"idivn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("idivn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imaskn"}})]),e._v(" "),_("h2",{attrs:{id:"imaskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imaskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imul"}})]),e._v(" "),_("h2",{attrs:{id:"imul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imuln"}})]),e._v(" "),_("h2",{attrs:{id:"imuln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imuln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ineg"}})]),e._v(" "),_("h2",{attrs:{id:"ineg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ineg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"inotn"}})]),e._v(" "),_("h2",{attrs:{id:"inotn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("inotn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"invm"}})]),e._v(" "),_("h2",{attrs:{id:"invm"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("invm")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.invm")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": inverse "),_("code",[e._v("a")]),e._v(" modulo "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ior"}})]),e._v(" "),_("h2",{attrs:{id:"ior"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ior")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ior")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iseven"}})]),e._v(" "),_("h2",{attrs:{id:"iseven"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isEven")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isneg"}})]),e._v(" "),_("h2",{attrs:{id:"isneg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isNeg")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isodd"}})]),e._v(" "),_("h2",{attrs:{id:"isodd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isOdd")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iszero"}})]),e._v(" "),_("h2",{attrs:{id:"iszero"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isZero")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishln"}})]),e._v(" "),_("h2",{attrs:{id:"ishln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishrn"}})]),e._v(" "),_("h2",{attrs:{id:"ishrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),_("OutboundLink")],1),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isqr"}})]),e._v(" "),_("h2",{attrs:{id:"isqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isub"}})]),e._v(" "),_("h2",{attrs:{id:"isub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isubn"}})]),e._v(" "),_("h2",{attrs:{id:"isubn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isubn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuand"}})]),e._v(" "),_("h2",{attrs:{id:"iuand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuor"}})]),e._v(" "),_("h2",{attrs:{id:"iuor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushln"}})]),e._v(" "),_("h2",{attrs:{id:"iushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushrn"}})]),e._v(" "),_("h2",{attrs:{id:"iushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuxor"}})]),e._v(" "),_("h2",{attrs:{id:"iuxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ixor"}})]),e._v(" "),_("h2",{attrs:{id:"ixor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ixor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lt"}})]),e._v(" "),_("h2",{attrs:{id:"lt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lte"}})]),e._v(" "),_("h2",{attrs:{id:"lte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lten"}})]),e._v(" "),_("h2",{attrs:{id:"lten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ltn"}})]),e._v(" "),_("h2",{attrs:{id:"ltn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ltn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"maskn"}})]),e._v(" "),_("h2",{attrs:{id:"maskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("maskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mod"}})]),e._v(" "),_("h2",{attrs:{id:"mod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"modn"}})]),e._v(" "),_("h2",{attrs:{id:"modn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("modn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.modn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("see")])]),e._v(": API consistency "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),_("OutboundLink")],1)]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mul"}})]),e._v(" "),_("h2",{attrs:{id:"mul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"muln"}})]),e._v(" "),_("h2",{attrs:{id:"muln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("muln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.muln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"neg"}})]),e._v(" "),_("h2",{attrs:{id:"neg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("neg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.neg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"notn"}})]),e._v(" "),_("h2",{attrs:{id:"notn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("notn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.notn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"or"}})]),e._v(" "),_("h2",{attrs:{id:"or"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("or")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.or")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"pow"}})]),e._v(" "),_("h2",{attrs:{id:"pow"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("pow")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.pow")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": raise "),_("code",[e._v("a")]),e._v(" to the power of "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"setn"}})]),e._v(" "),_("h2",{attrs:{id:"setn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("setn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.setn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shln"}})]),e._v(" "),_("h2",{attrs:{id:"shln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shrn"}})]),e._v(" "),_("h2",{attrs:{id:"shrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sqr"}})]),e._v(" "),_("h2",{attrs:{id:"sqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sub"}})]),e._v(" "),_("h2",{attrs:{id:"sub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"subn"}})]),e._v(" "),_("h2",{attrs:{id:"subn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("subn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.subn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"testn"}})]),e._v(" "),_("h2",{attrs:{id:"testn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("testn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.testn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarray"}})]),e._v(" "),_("h2",{attrs:{id:"toarray"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArray")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarraylike"}})]),e._v(" "),_("h2",{attrs:{id:"toarraylike"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("object")])]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to an instance of "),_("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("object")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("any")]),e._v("[]")])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobn"}})]),e._v(" "),_("h2",{attrs:{id:"tobn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBn")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobuffer"}})]),e._v(" "),_("h2",{attrs:{id:"tobuffer"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBuffer")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tohex"}})]),e._v(" "),_("h2",{attrs:{id:"tohex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toHex")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tojson"}})]),e._v(" "),_("h2",{attrs:{id:"tojson"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toJSON")]),e._v("(): "),_("code",[e._v("any")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:100"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tonumber"}})]),e._v(" "),_("h2",{attrs:{id:"tonumber"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toNumber")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tored"}})]),e._v(" "),_("h2",{attrs:{id:"tored"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toRed")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("ReductionContext")])]),e._v("): "),_("code",[e._v("RedBN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("ReductionContext")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("RedBN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tostring"}})]),e._v(" "),_("h2",{attrs:{id:"tostring"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toString")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toString")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:107"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"totwos"}})]),e._v(" "),_("h2",{attrs:{id:"totwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tou8a"}})]),e._v(" "),_("h2",{attrs:{id:"tou8a"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toU8a")]),e._v("(isBare?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v(" "),_("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uand"}})]),e._v(" "),_("h2",{attrs:{id:"uand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ucmp"}})]),e._v(" "),_("h2",{attrs:{id:"ucmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ucmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"umod"}})]),e._v(" "),_("h2",{attrs:{id:"umod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("umod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.umod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uor"}})]),e._v(" "),_("h2",{attrs:{id:"uor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushln"}})]),e._v(" "),_("h2",{attrs:{id:"ushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushrn"}})]),e._v(" "),_("h2",{attrs:{id:"ushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uxor"}})]),e._v(" "),_("h2",{attrs:{id:"uxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"xor"}})]),e._v(" "),_("h2",{attrs:{id:"xor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("xor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.xor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"zerobits"}})]),e._v(" "),_("h2",{attrs:{id:"zerobits"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("zeroBits")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"calclength"}})]),e._v(" "),_("h2",{attrs:{id:"static-calclength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-calclength","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" calcLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("calcLength")]),e._v("(_value: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:47"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("_value")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeabstracint"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),_("em",[_("code",[e._v("boolean")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),_("tr",[_("td",[e._v("bitLength")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),_("tr",[_("td",[e._v("isNegative")]),e._v(" "),_("td",[_("code",[e._v("boolean")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeaccountindex"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeaccountindex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeaccountindex","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAccountIndex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAccountIndex")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("Uint8Array")]),e._v(" | "),_("code",[e._v("number")]),e._v(" | "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:35"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("Uint8Array")]),e._v(" | "),_("code",[e._v("number")]),e._v(" | "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isbn"}})]),e._v(" "),_("h2",{attrs:{id:"static-isbn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" isBN")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isBN")]),e._v("(b: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"max"}})]),e._v(" "),_("h2",{attrs:{id:"static-max"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" max")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("max")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.max")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"min"}})]),e._v(" "),_("h2",{attrs:{id:"static-min"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" min")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("min")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.min")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mont"}})]),e._v(" "),_("h2",{attrs:{id:"static-mont"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" mont")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mont")]),e._v("(num: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mont")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("num")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"readlength"}})]),e._v(" "),_("h2",{attrs:{id:"static-readlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-readlength","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" readLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("readLength")]),e._v("(input: "),_("em",[_("code",[e._v("Uint8Array")])]),e._v("): ["),_("code",[e._v("number")]),e._v(", "),_("code",[e._v("number")]),e._v("]")]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:61"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("input")]),e._v(" "),_("td",[_("code",[e._v("Uint8Array")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" ["),_("code",[e._v("number")]),e._v(", "),_("code",[e._v("number")]),e._v("]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"red"}})]),e._v(" "),_("h2",{attrs:{id:"static-red"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" red")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("red")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.red")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"writelength"}})]),e._v(" "),_("h2",{attrs:{id:"static-writelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-writelength","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" writeLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("writeLength")]),e._v("(input: "),_("em",[_("code",[e._v("Uint8Array")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountIndex.ts:75"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("input")]),e._v(" "),_("td",[_("code",[e._v("Uint8Array")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/24.0868fa0c.js b/docs/assets/js/24.0868fa0c.js deleted file mode 100644 index 0838577b5a..0000000000 --- a/docs/assets/js/24.0868fa0c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{357:function(t,n,a){"use strict";a.r(n);var o=a(46),e=Object(o.a)({},function(){var t=this,n=t.$createElement,a=t._self._c||n;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"votingbalancesnominatorsfor"}})]),t._v(" "),a("h2",{attrs:{id:"votingbalancesnominatorsfor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#votingbalancesnominatorsfor","aria-hidden":"true"}},[t._v("#")]),t._v(" votingBalancesNominatorsFor")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("votingBalancesNominatorsFor")]),t._v("(api: "),a("em",[a("code",[t._v("ApiInterface$Rx")])]),t._v("): "),a("code",[t._v("(Anonymous function)")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("balances/votingBalancesNominatorsFor.ts:15"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("api")]),t._v(" "),a("td",[a("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("(Anonymous function)")])]),t._v(" "),a("hr")])},[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/240.c384fb29.js b/docs/assets/js/240.c384fb29.js deleted file mode 100644 index e81f10351c..0000000000 --- a/docs/assets/js/240.c384fb29.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[240],{560:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Address")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A wrapper around an AccountId and/or AccountIndex that is encoded with a prefix. Since we are dealing with underlying publicKeys (or shorter encoded addresses), we extend from Base with an AccountId/AccountIndex wrapper. Basically the Address is encoded as "),r("code",[t._v("[ , ...publicKey/...bytes ]")]),t._v(" as per spec")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("AccountIndex")]),t._v(">")],1),t._v(" "),r("p",[r("strong",[t._v("↳ Address")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Address")]),t._v("(value?: "),r("em",[r("code",[t._v("AnyAddress")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("AnyAddress")])]),t._v(" "),r("td",[t._v("new Uint8Array()")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:82"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"rawlength"}})]),t._v(" "),r("h2",{attrs:{id:"rawlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rawlength","aria-hidden":"true"}},[t._v("#")]),t._v(" rawLength")]),t._v(" "),r("p",[r("strong",[t._v("get rawLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L89",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:89"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the raw value, either AccountIndex or AccountId")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:98"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:105"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L112",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:112"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L119",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:119"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L127",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:127"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeaddress"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeaddress"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeaddress","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeAddress")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeAddress")]),t._v("(value: "),r("em",[r("code",[t._v("AnyAddress")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("AccountIndex")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("AnyAddress")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("AccountIndex")])],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/241.cf9360a5.js b/docs/assets/js/241.cf9360a5.js deleted file mode 100644 index b88194f76e..0000000000 --- a/docs/assets/js/241.cf9360a5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[241],{331:function(e,t,_){"use strict";_.r(t);var v=_(46),r=Object(v.a)({},function(){var e=this,t=e.$createElement,_=e._self._c||t;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("p",[_("em",[_("strong",[e._v("name")])]),e._v(": Amount")]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The Substrate Amount representation as a "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")]),e._v(".")],1),e._v(" "),_("h1",{attrs:{id:"hierarchy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")])],1),e._v(" "),_("p",[_("strong",[e._v("↳ Amount")])]),e._v(" "),_("h1",{attrs:{id:"implements"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),_("h1",{attrs:{id:"constructors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),_("p",[_("a",{attrs:{id:"constructor"}})]),e._v(" "),_("h2",{attrs:{id:"constructor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),_("p",[e._v("⊕ "),_("strong",[e._v("new Amount")]),e._v("(value?: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[e._v("Amount")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U128.ts:14"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[e._v("Amount")])],1),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"accessors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),_("p",[_("a",{attrs:{id:"encodedlength"}})]),e._v(" "),_("h2",{attrs:{id:"encodedlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),_("p",[_("strong",[e._v("get encodedLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isempty"}})]),e._v(" "),_("h2",{attrs:{id:"isempty"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),_("p",[_("strong",[e._v("get isEmpty")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"methods"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),_("p",[_("a",{attrs:{id:"abs"}})]),e._v(" "),_("h2",{attrs:{id:"abs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("abs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.abs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"add"}})]),e._v(" "),_("h2",{attrs:{id:"add"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("add")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.add")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"addn"}})]),e._v(" "),_("h2",{attrs:{id:"addn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("addn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.addn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"and"}})]),e._v(" "),_("h2",{attrs:{id:"and"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("and")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.and")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"andln"}})]),e._v(" "),_("h2",{attrs:{id:"andln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("andln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.andln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and (NOTE: "),_("code",[e._v("andln")]),e._v(" is going to be replaced with "),_("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bincn"}})]),e._v(" "),_("h2",{attrs:{id:"bincn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bincn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": add "),_("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bitlength"}})]),e._v(" "),_("h2",{attrs:{id:"bitlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bitLength")]),e._v("(): "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bytelength"}})]),e._v(" "),_("h2",{attrs:{id:"bytelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("byteLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"clone"}})]),e._v(" "),_("h2",{attrs:{id:"clone"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("clone")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.clone")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmp"}})]),e._v(" "),_("h2",{attrs:{id:"cmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmpn"}})]),e._v(" "),_("h2",{attrs:{id:"cmpn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmpn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"div"}})]),e._v(" "),_("h2",{attrs:{id:"div"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("div")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.div")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divround"}})]),e._v(" "),_("h2",{attrs:{id:"divround"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divRound")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divn"}})]),e._v(" "),_("h2",{attrs:{id:"divn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"egcd"}})]),e._v(" "),_("h2",{attrs:{id:"egcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("egcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("object")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Extended GCD results "),_("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("object")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eq"}})]),e._v(" "),_("h2",{attrs:{id:"eq"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eq")]),e._v("(other?: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.eq")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eqn"}})]),e._v(" "),_("h2",{attrs:{id:"eqn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eqn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"fromtwos"}})]),e._v(" "),_("h2",{attrs:{id:"fromtwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("fromTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gcd"}})]),e._v(" "),_("h2",{attrs:{id:"gcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gt"}})]),e._v(" "),_("h2",{attrs:{id:"gt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gte"}})]),e._v(" "),_("h2",{attrs:{id:"gte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gten"}})]),e._v(" "),_("h2",{attrs:{id:"gten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gtn"}})]),e._v(" "),_("h2",{attrs:{id:"gtn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gtn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iabs"}})]),e._v(" "),_("h2",{attrs:{id:"iabs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iabs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iadd"}})]),e._v(" "),_("h2",{attrs:{id:"iadd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iadd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iaddn"}})]),e._v(" "),_("h2",{attrs:{id:"iaddn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iaddn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iand"}})]),e._v(" "),_("h2",{attrs:{id:"iand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"idivn"}})]),e._v(" "),_("h2",{attrs:{id:"idivn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("idivn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imaskn"}})]),e._v(" "),_("h2",{attrs:{id:"imaskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imaskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imul"}})]),e._v(" "),_("h2",{attrs:{id:"imul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imuln"}})]),e._v(" "),_("h2",{attrs:{id:"imuln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imuln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ineg"}})]),e._v(" "),_("h2",{attrs:{id:"ineg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ineg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"inotn"}})]),e._v(" "),_("h2",{attrs:{id:"inotn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("inotn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"invm"}})]),e._v(" "),_("h2",{attrs:{id:"invm"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("invm")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.invm")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": inverse "),_("code",[e._v("a")]),e._v(" modulo "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ior"}})]),e._v(" "),_("h2",{attrs:{id:"ior"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ior")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ior")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iseven"}})]),e._v(" "),_("h2",{attrs:{id:"iseven"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isEven")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isneg"}})]),e._v(" "),_("h2",{attrs:{id:"isneg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isNeg")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isodd"}})]),e._v(" "),_("h2",{attrs:{id:"isodd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isOdd")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iszero"}})]),e._v(" "),_("h2",{attrs:{id:"iszero"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isZero")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishln"}})]),e._v(" "),_("h2",{attrs:{id:"ishln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishrn"}})]),e._v(" "),_("h2",{attrs:{id:"ishrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),_("OutboundLink")],1),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isqr"}})]),e._v(" "),_("h2",{attrs:{id:"isqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isub"}})]),e._v(" "),_("h2",{attrs:{id:"isub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isubn"}})]),e._v(" "),_("h2",{attrs:{id:"isubn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isubn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuand"}})]),e._v(" "),_("h2",{attrs:{id:"iuand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuor"}})]),e._v(" "),_("h2",{attrs:{id:"iuor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushln"}})]),e._v(" "),_("h2",{attrs:{id:"iushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushrn"}})]),e._v(" "),_("h2",{attrs:{id:"iushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuxor"}})]),e._v(" "),_("h2",{attrs:{id:"iuxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ixor"}})]),e._v(" "),_("h2",{attrs:{id:"ixor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ixor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lt"}})]),e._v(" "),_("h2",{attrs:{id:"lt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lte"}})]),e._v(" "),_("h2",{attrs:{id:"lte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lten"}})]),e._v(" "),_("h2",{attrs:{id:"lten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ltn"}})]),e._v(" "),_("h2",{attrs:{id:"ltn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ltn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"maskn"}})]),e._v(" "),_("h2",{attrs:{id:"maskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("maskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mod"}})]),e._v(" "),_("h2",{attrs:{id:"mod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"modn"}})]),e._v(" "),_("h2",{attrs:{id:"modn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("modn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.modn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("see")])]),e._v(": API consistency "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),_("OutboundLink")],1)]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mul"}})]),e._v(" "),_("h2",{attrs:{id:"mul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"muln"}})]),e._v(" "),_("h2",{attrs:{id:"muln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("muln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.muln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"neg"}})]),e._v(" "),_("h2",{attrs:{id:"neg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("neg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.neg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"notn"}})]),e._v(" "),_("h2",{attrs:{id:"notn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("notn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.notn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"or"}})]),e._v(" "),_("h2",{attrs:{id:"or"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("or")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.or")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"pow"}})]),e._v(" "),_("h2",{attrs:{id:"pow"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("pow")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.pow")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": raise "),_("code",[e._v("a")]),e._v(" to the power of "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"setn"}})]),e._v(" "),_("h2",{attrs:{id:"setn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("setn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.setn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shln"}})]),e._v(" "),_("h2",{attrs:{id:"shln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shrn"}})]),e._v(" "),_("h2",{attrs:{id:"shrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sqr"}})]),e._v(" "),_("h2",{attrs:{id:"sqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sub"}})]),e._v(" "),_("h2",{attrs:{id:"sub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"subn"}})]),e._v(" "),_("h2",{attrs:{id:"subn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("subn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.subn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"testn"}})]),e._v(" "),_("h2",{attrs:{id:"testn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("testn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.testn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarray"}})]),e._v(" "),_("h2",{attrs:{id:"toarray"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArray")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarraylike"}})]),e._v(" "),_("h2",{attrs:{id:"toarraylike"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("object")])]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to an instance of "),_("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("object")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("any")]),e._v("[]")])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobn"}})]),e._v(" "),_("h2",{attrs:{id:"tobn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBn")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobuffer"}})]),e._v(" "),_("h2",{attrs:{id:"tobuffer"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBuffer")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tohex"}})]),e._v(" "),_("h2",{attrs:{id:"tohex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toHex")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tojson"}})]),e._v(" "),_("h2",{attrs:{id:"tojson"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toJSON")]),e._v("(): "),_("code",[e._v("any")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tonumber"}})]),e._v(" "),_("h2",{attrs:{id:"tonumber"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toNumber")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tored"}})]),e._v(" "),_("h2",{attrs:{id:"tored"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toRed")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("ReductionContext")])]),e._v("): "),_("code",[e._v("RedBN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("ReductionContext")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("RedBN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tostring"}})]),e._v(" "),_("h2",{attrs:{id:"tostring"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toString")]),e._v("(base?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toString")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v(" "),_("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"totwos"}})]),e._v(" "),_("h2",{attrs:{id:"totwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tou8a"}})]),e._v(" "),_("h2",{attrs:{id:"tou8a"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toU8a")]),e._v("(isBare?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v(" "),_("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uand"}})]),e._v(" "),_("h2",{attrs:{id:"uand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ucmp"}})]),e._v(" "),_("h2",{attrs:{id:"ucmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ucmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"umod"}})]),e._v(" "),_("h2",{attrs:{id:"umod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("umod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.umod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uor"}})]),e._v(" "),_("h2",{attrs:{id:"uor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushln"}})]),e._v(" "),_("h2",{attrs:{id:"ushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushrn"}})]),e._v(" "),_("h2",{attrs:{id:"ushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uxor"}})]),e._v(" "),_("h2",{attrs:{id:"uxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"xor"}})]),e._v(" "),_("h2",{attrs:{id:"xor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("xor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.xor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"zerobits"}})]),e._v(" "),_("h2",{attrs:{id:"zerobits"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("zeroBits")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeabstracint"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),_("em",[_("code",[e._v("boolean")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),_("tr",[_("td",[e._v("bitLength")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),_("tr",[_("td",[e._v("isNegative")]),e._v(" "),_("td",[_("code",[e._v("boolean")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isbn"}})]),e._v(" "),_("h2",{attrs:{id:"static-isbn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" isBN")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isBN")]),e._v("(b: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"max"}})]),e._v(" "),_("h2",{attrs:{id:"static-max"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" max")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("max")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.max")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"min"}})]),e._v(" "),_("h2",{attrs:{id:"static-min"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" min")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("min")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.min")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mont"}})]),e._v(" "),_("h2",{attrs:{id:"static-mont"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" mont")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mont")]),e._v("(num: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mont")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("num")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"red"}})]),e._v(" "),_("h2",{attrs:{id:"static-red"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" red")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("red")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.red")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/242.8ddb5516.js b/docs/assets/js/242.8ddb5516.js deleted file mode 100644 index 14092eff03..0000000000 --- a/docs/assets/js/242.8ddb5516.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[242],{318:function(e,t,_){"use strict";_.r(t);var v=_(46),r=Object(v.a)({},function(){var e=this,t=e.$createElement,_=e._self._c||t;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("p",[_("em",[_("strong",[e._v("name")])]),e._v(": AssetOf")]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The Substrate AssetOf representation as a "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")]),e._v(".")],1),e._v(" "),_("h1",{attrs:{id:"hierarchy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")])],1),e._v(" "),_("p",[_("strong",[e._v("↳ AssetOf")])]),e._v(" "),_("h1",{attrs:{id:"implements"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),_("h1",{attrs:{id:"constructors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),_("p",[_("a",{attrs:{id:"constructor"}})]),e._v(" "),_("h2",{attrs:{id:"constructor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),_("p",[e._v("⊕ "),_("strong",[e._v("new AssetOf")]),e._v("(value?: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[e._v("AssetOf")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U128.ts:14"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[e._v("AssetOf")])],1),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"accessors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),_("p",[_("a",{attrs:{id:"encodedlength"}})]),e._v(" "),_("h2",{attrs:{id:"encodedlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),_("p",[_("strong",[e._v("get encodedLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isempty"}})]),e._v(" "),_("h2",{attrs:{id:"isempty"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),_("p",[_("strong",[e._v("get isEmpty")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"methods"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),_("p",[_("a",{attrs:{id:"abs"}})]),e._v(" "),_("h2",{attrs:{id:"abs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("abs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.abs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"add"}})]),e._v(" "),_("h2",{attrs:{id:"add"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("add")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.add")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"addn"}})]),e._v(" "),_("h2",{attrs:{id:"addn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("addn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.addn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"and"}})]),e._v(" "),_("h2",{attrs:{id:"and"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("and")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.and")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"andln"}})]),e._v(" "),_("h2",{attrs:{id:"andln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("andln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.andln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and (NOTE: "),_("code",[e._v("andln")]),e._v(" is going to be replaced with "),_("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bincn"}})]),e._v(" "),_("h2",{attrs:{id:"bincn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bincn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": add "),_("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bitlength"}})]),e._v(" "),_("h2",{attrs:{id:"bitlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bitLength")]),e._v("(): "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bytelength"}})]),e._v(" "),_("h2",{attrs:{id:"bytelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("byteLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"clone"}})]),e._v(" "),_("h2",{attrs:{id:"clone"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("clone")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.clone")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmp"}})]),e._v(" "),_("h2",{attrs:{id:"cmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmpn"}})]),e._v(" "),_("h2",{attrs:{id:"cmpn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmpn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"div"}})]),e._v(" "),_("h2",{attrs:{id:"div"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("div")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.div")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divround"}})]),e._v(" "),_("h2",{attrs:{id:"divround"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divRound")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divn"}})]),e._v(" "),_("h2",{attrs:{id:"divn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"egcd"}})]),e._v(" "),_("h2",{attrs:{id:"egcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("egcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("object")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Extended GCD results "),_("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("object")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eq"}})]),e._v(" "),_("h2",{attrs:{id:"eq"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eq")]),e._v("(other?: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.eq")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eqn"}})]),e._v(" "),_("h2",{attrs:{id:"eqn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eqn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"fromtwos"}})]),e._v(" "),_("h2",{attrs:{id:"fromtwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("fromTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gcd"}})]),e._v(" "),_("h2",{attrs:{id:"gcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gt"}})]),e._v(" "),_("h2",{attrs:{id:"gt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gte"}})]),e._v(" "),_("h2",{attrs:{id:"gte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gten"}})]),e._v(" "),_("h2",{attrs:{id:"gten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gtn"}})]),e._v(" "),_("h2",{attrs:{id:"gtn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gtn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iabs"}})]),e._v(" "),_("h2",{attrs:{id:"iabs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iabs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iadd"}})]),e._v(" "),_("h2",{attrs:{id:"iadd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iadd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iaddn"}})]),e._v(" "),_("h2",{attrs:{id:"iaddn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iaddn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iand"}})]),e._v(" "),_("h2",{attrs:{id:"iand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"idivn"}})]),e._v(" "),_("h2",{attrs:{id:"idivn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("idivn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imaskn"}})]),e._v(" "),_("h2",{attrs:{id:"imaskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imaskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imul"}})]),e._v(" "),_("h2",{attrs:{id:"imul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imuln"}})]),e._v(" "),_("h2",{attrs:{id:"imuln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imuln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ineg"}})]),e._v(" "),_("h2",{attrs:{id:"ineg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ineg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"inotn"}})]),e._v(" "),_("h2",{attrs:{id:"inotn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("inotn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"invm"}})]),e._v(" "),_("h2",{attrs:{id:"invm"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("invm")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.invm")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": inverse "),_("code",[e._v("a")]),e._v(" modulo "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ior"}})]),e._v(" "),_("h2",{attrs:{id:"ior"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ior")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ior")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iseven"}})]),e._v(" "),_("h2",{attrs:{id:"iseven"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isEven")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isneg"}})]),e._v(" "),_("h2",{attrs:{id:"isneg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isNeg")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isodd"}})]),e._v(" "),_("h2",{attrs:{id:"isodd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isOdd")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iszero"}})]),e._v(" "),_("h2",{attrs:{id:"iszero"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isZero")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishln"}})]),e._v(" "),_("h2",{attrs:{id:"ishln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishrn"}})]),e._v(" "),_("h2",{attrs:{id:"ishrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),_("OutboundLink")],1),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isqr"}})]),e._v(" "),_("h2",{attrs:{id:"isqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isub"}})]),e._v(" "),_("h2",{attrs:{id:"isub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isubn"}})]),e._v(" "),_("h2",{attrs:{id:"isubn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isubn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuand"}})]),e._v(" "),_("h2",{attrs:{id:"iuand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuor"}})]),e._v(" "),_("h2",{attrs:{id:"iuor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushln"}})]),e._v(" "),_("h2",{attrs:{id:"iushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushrn"}})]),e._v(" "),_("h2",{attrs:{id:"iushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuxor"}})]),e._v(" "),_("h2",{attrs:{id:"iuxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ixor"}})]),e._v(" "),_("h2",{attrs:{id:"ixor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ixor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lt"}})]),e._v(" "),_("h2",{attrs:{id:"lt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lte"}})]),e._v(" "),_("h2",{attrs:{id:"lte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lten"}})]),e._v(" "),_("h2",{attrs:{id:"lten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ltn"}})]),e._v(" "),_("h2",{attrs:{id:"ltn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ltn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"maskn"}})]),e._v(" "),_("h2",{attrs:{id:"maskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("maskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mod"}})]),e._v(" "),_("h2",{attrs:{id:"mod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"modn"}})]),e._v(" "),_("h2",{attrs:{id:"modn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("modn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.modn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("see")])]),e._v(": API consistency "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),_("OutboundLink")],1)]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mul"}})]),e._v(" "),_("h2",{attrs:{id:"mul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"muln"}})]),e._v(" "),_("h2",{attrs:{id:"muln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("muln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.muln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"neg"}})]),e._v(" "),_("h2",{attrs:{id:"neg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("neg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.neg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"notn"}})]),e._v(" "),_("h2",{attrs:{id:"notn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("notn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.notn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"or"}})]),e._v(" "),_("h2",{attrs:{id:"or"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("or")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.or")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"pow"}})]),e._v(" "),_("h2",{attrs:{id:"pow"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("pow")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.pow")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": raise "),_("code",[e._v("a")]),e._v(" to the power of "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"setn"}})]),e._v(" "),_("h2",{attrs:{id:"setn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("setn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.setn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shln"}})]),e._v(" "),_("h2",{attrs:{id:"shln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shrn"}})]),e._v(" "),_("h2",{attrs:{id:"shrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sqr"}})]),e._v(" "),_("h2",{attrs:{id:"sqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sub"}})]),e._v(" "),_("h2",{attrs:{id:"sub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"subn"}})]),e._v(" "),_("h2",{attrs:{id:"subn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("subn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.subn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"testn"}})]),e._v(" "),_("h2",{attrs:{id:"testn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("testn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.testn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarray"}})]),e._v(" "),_("h2",{attrs:{id:"toarray"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArray")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarraylike"}})]),e._v(" "),_("h2",{attrs:{id:"toarraylike"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("object")])]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to an instance of "),_("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("object")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("any")]),e._v("[]")])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobn"}})]),e._v(" "),_("h2",{attrs:{id:"tobn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBn")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobuffer"}})]),e._v(" "),_("h2",{attrs:{id:"tobuffer"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBuffer")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tohex"}})]),e._v(" "),_("h2",{attrs:{id:"tohex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toHex")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tojson"}})]),e._v(" "),_("h2",{attrs:{id:"tojson"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toJSON")]),e._v("(): "),_("code",[e._v("any")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tonumber"}})]),e._v(" "),_("h2",{attrs:{id:"tonumber"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toNumber")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tored"}})]),e._v(" "),_("h2",{attrs:{id:"tored"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toRed")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("ReductionContext")])]),e._v("): "),_("code",[e._v("RedBN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("ReductionContext")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("RedBN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tostring"}})]),e._v(" "),_("h2",{attrs:{id:"tostring"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toString")]),e._v("(base?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toString")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v(" "),_("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"totwos"}})]),e._v(" "),_("h2",{attrs:{id:"totwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tou8a"}})]),e._v(" "),_("h2",{attrs:{id:"tou8a"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toU8a")]),e._v("(isBare?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v(" "),_("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uand"}})]),e._v(" "),_("h2",{attrs:{id:"uand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ucmp"}})]),e._v(" "),_("h2",{attrs:{id:"ucmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ucmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"umod"}})]),e._v(" "),_("h2",{attrs:{id:"umod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("umod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.umod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uor"}})]),e._v(" "),_("h2",{attrs:{id:"uor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushln"}})]),e._v(" "),_("h2",{attrs:{id:"ushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushrn"}})]),e._v(" "),_("h2",{attrs:{id:"ushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uxor"}})]),e._v(" "),_("h2",{attrs:{id:"uxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"xor"}})]),e._v(" "),_("h2",{attrs:{id:"xor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("xor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.xor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"zerobits"}})]),e._v(" "),_("h2",{attrs:{id:"zerobits"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("zeroBits")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeabstracint"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),_("em",[_("code",[e._v("boolean")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),_("tr",[_("td",[e._v("bitLength")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),_("tr",[_("td",[e._v("isNegative")]),e._v(" "),_("td",[_("code",[e._v("boolean")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isbn"}})]),e._v(" "),_("h2",{attrs:{id:"static-isbn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" isBN")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isBN")]),e._v("(b: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"max"}})]),e._v(" "),_("h2",{attrs:{id:"static-max"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" max")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("max")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.max")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"min"}})]),e._v(" "),_("h2",{attrs:{id:"static-min"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" min")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("min")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.min")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mont"}})]),e._v(" "),_("h2",{attrs:{id:"static-mont"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" mont")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mont")]),e._v("(num: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mont")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("num")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"red"}})]),e._v(" "),_("h2",{attrs:{id:"static-red"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" red")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("red")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.red")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/243.9ef77bc3.js b/docs/assets/js/243.9ef77bc3.js deleted file mode 100644 index 21b9b5b652..0000000000 --- a/docs/assets/js/243.9ef77bc3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[243],{595:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": AttestedCandidate")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": An attested candidate")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ AttestedCandidate")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new AttestedCandidate")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/AttestedCandidate.ts:88"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/244.0ccec493.js b/docs/assets/js/244.0ccec493.js deleted file mode 100644 index 3d1679743d..0000000000 --- a/docs/assets/js/244.0ccec493.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[244],{319:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ AvailabilityVote")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new AvailabilityVote")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v(", value: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.availabilityvote.html"}},[e._v("AvailabilityVote")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.availabilityvote.html"}},[e._v("AvailabilityVote")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/245.d2970f61.js b/docs/assets/js/245.d2970f61.js deleted file mode 100644 index c61b284d76..0000000000 --- a/docs/assets/js/245.d2970f61.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[245],{312:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ BalanceUpload")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new BalanceUpload")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v(", value: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.balanceupload.html"}},[e._v("BalanceUpload")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.balanceupload.html"}},[e._v("BalanceUpload")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/246.964b56ca.js b/docs/assets/js/246.964b56ca.js deleted file mode 100644 index d7f20262d9..0000000000 --- a/docs/assets/js/246.964b56ca.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[246],{592:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ CandidateReceipt")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new CandidateReceipt")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("CandidateReceipt")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/AttestedCandidate.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("CandidateReceipt")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/247.fe054aa5.js b/docs/assets/js/247.fe054aa5.js deleted file mode 100644 index fb11dae814..0000000000 --- a/docs/assets/js/247.fe054aa5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[247],{425:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ CandidateSignature")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[e._v("ExplicitCandidateSignature")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[e._v("ImplicitCandidateSignature")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new CandidateSignature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[e._v("CandidateSignature")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H512.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[e._v("CandidateSignature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/248.3616d6f4.js b/docs/assets/js/248.3616d6f4.js deleted file mode 100644 index 9a9f55948f..0000000000 --- a/docs/assets/js/248.3616d6f4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[248],{320:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ EgressQueueRoot")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new EgressQueueRoot")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v(", value: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.egressqueueroot.html"}},[e._v("EgressQueueRoot")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.egressqueueroot.html"}},[e._v("EgressQueueRoot")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/249.4b683772.js b/docs/assets/js/249.4b683772.js deleted file mode 100644 index abb8b9b5ae..0000000000 --- a/docs/assets/js/249.4b683772.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[249],{431:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[e._v("CandidateSignature")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ExplicitCandidateSignature")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ExplicitCandidateSignature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[e._v("ExplicitCandidateSignature")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H512.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[e._v("ExplicitCandidateSignature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/25.c9768e23.js b/docs/assets/js/25.c9768e23.js deleted file mode 100644 index 44bba73b4f..0000000000 --- a/docs/assets/js/25.c9768e23.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{358:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"bestnumber"}})]),t._v(" "),n("h2",{attrs:{id:"bestnumber"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#bestnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" bestNumber")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bestNumber")]),t._v("(api: "),n("em",[n("code",[t._v("ApiInterface$Rx")])]),t._v("): "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/bestNumber.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("chain/bestNumber.ts:23"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Get the latest block number.")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[t._v("api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`the current best block is #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("api")]),t._v(" "),n("td",[n("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/250.73e40a70.js b/docs/assets/js/250.73e40a70.js deleted file mode 100644 index ffc63e4dd5..0000000000 --- a/docs/assets/js/250.73e40a70.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[250],{485:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ HeadData")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new HeadData")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.headdata.html"}},[e._v("HeadData")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.headdata.html"}},[e._v("HeadData")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:61"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/251.7558f2ea.js b/docs/assets/js/251.7558f2ea.js deleted file mode 100644 index d28610df45..0000000000 --- a/docs/assets/js/251.7558f2ea.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[251],{428:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[e._v("CandidateSignature")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ImplicitCandidateSignature")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ImplicitCandidateSignature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[e._v("ImplicitCandidateSignature")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H512.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[e._v("ImplicitCandidateSignature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/252.15f2dfec.js b/docs/assets/js/252.15f2dfec.js deleted file mode 100644 index 3deeedc17b..0000000000 --- a/docs/assets/js/252.15f2dfec.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[252],{589:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("ImplicitCandidateSignature")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("ExplicitCandidateSignature")]),t._v(">")],1),t._v(" "),r("p",[r("strong",[t._v("↳ ValidityAttestation")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new ValidityAttestation")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityattestation.html"}},[t._v("ValidityAttestation")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/AttestedCandidate.ts:54"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityattestation.html"}},[t._v("ValidityAttestation")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"asexplicitcandidatesignature"}})]),t._v(" "),r("h2",{attrs:{id:"asexplicitcandidatesignature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asexplicitcandidatesignature","aria-hidden":"true"}},[t._v("#")]),t._v(" asExplicitCandidateSignature")]),t._v(" "),r("p",[r("strong",[t._v("get asExplicitCandidateSignature")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("ExplicitCandidateSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/AttestedCandidate.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("ExplicitCandidateSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("ExplicitCandidateSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"asimplicitcandidatesignature"}})]),t._v(" "),r("h2",{attrs:{id:"asimplicitcandidatesignature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asimplicitcandidatesignature","aria-hidden":"true"}},[t._v("#")]),t._v(" asImplicitCandidateSignature")]),t._v(" "),r("p",[r("strong",[t._v("get asImplicitCandidateSignature")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("ImplicitCandidateSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/AttestedCandidate.ts:75"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("ImplicitCandidateSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("ImplicitCandidateSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:114"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),t._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" index")]),t._v(" "),r("p",[r("strong",[t._v("get index")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[t._v("index")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:121"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The index of the metadata value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:128"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),t._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[t._v("#")]),t._v(" isNone")]),t._v(" "),r("p",[r("strong",[t._v("get isNone")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[t._v("isNone")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:135"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v(" type")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isnull"}})]),t._v(" "),r("h2",{attrs:{id:"isnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[t._v("#")]),t._v(" isNull")]),t._v(" "),r("p",[r("strong",[t._v("get isNull")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[t._v("isNull")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:142"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v(" type (deprecated, use isNone)")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("get type")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[t._v("type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:149"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The name of the type this enum value represents")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),t._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[t._v("#")]),t._v(" value")]),t._v(" "),r("p",[r("strong",[t._v("get value")]),t._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[t._v("value")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:156"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The value of the enum")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:163"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:183"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),t._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" toNumber")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toNumber")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[t._v("toNumber")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:192"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the number representation for the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:199"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:209"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("code",[t._v("EnumConstructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/EnumType.ts:101"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("EnumConstructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/253.95cd7122.js b/docs/assets/js/253.95cd7122.js deleted file mode 100644 index d77d449c03..0000000000 --- a/docs/assets/js/253.95cd7122.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[253],{330:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ValidityVote")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ValidityVote")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v(", value: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityvote.html"}},[e._v("ValidityVote")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityvote.html"}},[e._v("ValidityVote")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/254.b0b505a9.js b/docs/assets/js/254.b0b505a9.js deleted file mode 100644 index 86e0274147..0000000000 --- a/docs/assets/js/254.b0b505a9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[254],{422:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ AuthorityId")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[e._v("SessionKey")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new AuthorityId")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[e._v("AuthorityId")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v(" "),r("td",[e._v("new Uint8Array()")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[e._v("AuthorityId")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:53"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:60"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"static-encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-encode","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#encode"}},[e._v("encode")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/255.cbeb6d0d.js b/docs/assets/js/255.cbeb6d0d.js deleted file mode 100644 index ffe832a28c..0000000000 --- a/docs/assets/js/255.cbeb6d0d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[255],{328:function(e,t,_){"use strict";_.r(t);var v=_(46),r=Object(v.a)({},function(){var e=this,t=e.$createElement,_=e._self._c||t;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("p",[_("em",[_("strong",[e._v("name")])]),e._v(": Balance")]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The Substrate Balance representation as a "),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")]),e._v(".")],1),e._v(" "),_("h1",{attrs:{id:"hierarchy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")])],1),e._v(" "),_("p",[_("strong",[e._v("↳ Balance")])]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[e._v("BalanceOf")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[e._v("Amount")])],1),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[e._v("AssetOf")])],1),e._v(" "),_("h1",{attrs:{id:"implements"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),_("h1",{attrs:{id:"constructors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),_("p",[_("a",{attrs:{id:"constructor"}})]),e._v(" "),_("h2",{attrs:{id:"constructor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),_("p",[e._v("⊕ "),_("strong",[e._v("new Balance")]),e._v("(value?: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U128.ts:14"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")])],1),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"accessors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),_("p",[_("a",{attrs:{id:"encodedlength"}})]),e._v(" "),_("h2",{attrs:{id:"encodedlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),_("p",[_("strong",[e._v("get encodedLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isempty"}})]),e._v(" "),_("h2",{attrs:{id:"isempty"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),_("p",[_("strong",[e._v("get isEmpty")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"methods"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),_("p",[_("a",{attrs:{id:"abs"}})]),e._v(" "),_("h2",{attrs:{id:"abs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("abs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.abs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"add"}})]),e._v(" "),_("h2",{attrs:{id:"add"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("add")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.add")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"addn"}})]),e._v(" "),_("h2",{attrs:{id:"addn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("addn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.addn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"and"}})]),e._v(" "),_("h2",{attrs:{id:"and"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("and")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.and")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"andln"}})]),e._v(" "),_("h2",{attrs:{id:"andln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("andln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.andln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and (NOTE: "),_("code",[e._v("andln")]),e._v(" is going to be replaced with "),_("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bincn"}})]),e._v(" "),_("h2",{attrs:{id:"bincn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bincn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": add "),_("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bitlength"}})]),e._v(" "),_("h2",{attrs:{id:"bitlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bitLength")]),e._v("(): "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bytelength"}})]),e._v(" "),_("h2",{attrs:{id:"bytelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("byteLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"clone"}})]),e._v(" "),_("h2",{attrs:{id:"clone"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("clone")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.clone")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmp"}})]),e._v(" "),_("h2",{attrs:{id:"cmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmpn"}})]),e._v(" "),_("h2",{attrs:{id:"cmpn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmpn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"div"}})]),e._v(" "),_("h2",{attrs:{id:"div"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("div")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.div")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divround"}})]),e._v(" "),_("h2",{attrs:{id:"divround"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divRound")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divn"}})]),e._v(" "),_("h2",{attrs:{id:"divn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"egcd"}})]),e._v(" "),_("h2",{attrs:{id:"egcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("egcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("object")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Extended GCD results "),_("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("object")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eq"}})]),e._v(" "),_("h2",{attrs:{id:"eq"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eq")]),e._v("(other?: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.eq")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eqn"}})]),e._v(" "),_("h2",{attrs:{id:"eqn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eqn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"fromtwos"}})]),e._v(" "),_("h2",{attrs:{id:"fromtwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("fromTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gcd"}})]),e._v(" "),_("h2",{attrs:{id:"gcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gt"}})]),e._v(" "),_("h2",{attrs:{id:"gt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gte"}})]),e._v(" "),_("h2",{attrs:{id:"gte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gten"}})]),e._v(" "),_("h2",{attrs:{id:"gten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gtn"}})]),e._v(" "),_("h2",{attrs:{id:"gtn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gtn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iabs"}})]),e._v(" "),_("h2",{attrs:{id:"iabs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iabs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iadd"}})]),e._v(" "),_("h2",{attrs:{id:"iadd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iadd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iaddn"}})]),e._v(" "),_("h2",{attrs:{id:"iaddn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iaddn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iand"}})]),e._v(" "),_("h2",{attrs:{id:"iand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"idivn"}})]),e._v(" "),_("h2",{attrs:{id:"idivn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("idivn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imaskn"}})]),e._v(" "),_("h2",{attrs:{id:"imaskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imaskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imul"}})]),e._v(" "),_("h2",{attrs:{id:"imul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imuln"}})]),e._v(" "),_("h2",{attrs:{id:"imuln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imuln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ineg"}})]),e._v(" "),_("h2",{attrs:{id:"ineg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ineg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"inotn"}})]),e._v(" "),_("h2",{attrs:{id:"inotn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("inotn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"invm"}})]),e._v(" "),_("h2",{attrs:{id:"invm"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("invm")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.invm")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": inverse "),_("code",[e._v("a")]),e._v(" modulo "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ior"}})]),e._v(" "),_("h2",{attrs:{id:"ior"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ior")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ior")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iseven"}})]),e._v(" "),_("h2",{attrs:{id:"iseven"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isEven")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isneg"}})]),e._v(" "),_("h2",{attrs:{id:"isneg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isNeg")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isodd"}})]),e._v(" "),_("h2",{attrs:{id:"isodd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isOdd")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iszero"}})]),e._v(" "),_("h2",{attrs:{id:"iszero"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isZero")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishln"}})]),e._v(" "),_("h2",{attrs:{id:"ishln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishrn"}})]),e._v(" "),_("h2",{attrs:{id:"ishrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),_("OutboundLink")],1),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isqr"}})]),e._v(" "),_("h2",{attrs:{id:"isqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isub"}})]),e._v(" "),_("h2",{attrs:{id:"isub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isubn"}})]),e._v(" "),_("h2",{attrs:{id:"isubn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isubn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuand"}})]),e._v(" "),_("h2",{attrs:{id:"iuand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuor"}})]),e._v(" "),_("h2",{attrs:{id:"iuor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushln"}})]),e._v(" "),_("h2",{attrs:{id:"iushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushrn"}})]),e._v(" "),_("h2",{attrs:{id:"iushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuxor"}})]),e._v(" "),_("h2",{attrs:{id:"iuxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ixor"}})]),e._v(" "),_("h2",{attrs:{id:"ixor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ixor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lt"}})]),e._v(" "),_("h2",{attrs:{id:"lt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lte"}})]),e._v(" "),_("h2",{attrs:{id:"lte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lten"}})]),e._v(" "),_("h2",{attrs:{id:"lten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ltn"}})]),e._v(" "),_("h2",{attrs:{id:"ltn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ltn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"maskn"}})]),e._v(" "),_("h2",{attrs:{id:"maskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("maskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mod"}})]),e._v(" "),_("h2",{attrs:{id:"mod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"modn"}})]),e._v(" "),_("h2",{attrs:{id:"modn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("modn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.modn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("see")])]),e._v(": API consistency "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),_("OutboundLink")],1)]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mul"}})]),e._v(" "),_("h2",{attrs:{id:"mul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"muln"}})]),e._v(" "),_("h2",{attrs:{id:"muln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("muln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.muln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"neg"}})]),e._v(" "),_("h2",{attrs:{id:"neg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("neg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.neg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"notn"}})]),e._v(" "),_("h2",{attrs:{id:"notn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("notn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.notn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"or"}})]),e._v(" "),_("h2",{attrs:{id:"or"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("or")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.or")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"pow"}})]),e._v(" "),_("h2",{attrs:{id:"pow"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("pow")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.pow")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": raise "),_("code",[e._v("a")]),e._v(" to the power of "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"setn"}})]),e._v(" "),_("h2",{attrs:{id:"setn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("setn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.setn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shln"}})]),e._v(" "),_("h2",{attrs:{id:"shln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shrn"}})]),e._v(" "),_("h2",{attrs:{id:"shrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sqr"}})]),e._v(" "),_("h2",{attrs:{id:"sqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sub"}})]),e._v(" "),_("h2",{attrs:{id:"sub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"subn"}})]),e._v(" "),_("h2",{attrs:{id:"subn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("subn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.subn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"testn"}})]),e._v(" "),_("h2",{attrs:{id:"testn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("testn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.testn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarray"}})]),e._v(" "),_("h2",{attrs:{id:"toarray"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArray")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarraylike"}})]),e._v(" "),_("h2",{attrs:{id:"toarraylike"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("object")])]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to an instance of "),_("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("object")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("any")]),e._v("[]")])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobn"}})]),e._v(" "),_("h2",{attrs:{id:"tobn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBn")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobuffer"}})]),e._v(" "),_("h2",{attrs:{id:"tobuffer"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBuffer")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tohex"}})]),e._v(" "),_("h2",{attrs:{id:"tohex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toHex")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tojson"}})]),e._v(" "),_("h2",{attrs:{id:"tojson"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toJSON")]),e._v("(): "),_("code",[e._v("any")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tonumber"}})]),e._v(" "),_("h2",{attrs:{id:"tonumber"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toNumber")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tored"}})]),e._v(" "),_("h2",{attrs:{id:"tored"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toRed")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("ReductionContext")])]),e._v("): "),_("code",[e._v("RedBN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("ReductionContext")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("RedBN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tostring"}})]),e._v(" "),_("h2",{attrs:{id:"tostring"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toString")]),e._v("(base?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toString")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v(" "),_("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"totwos"}})]),e._v(" "),_("h2",{attrs:{id:"totwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tou8a"}})]),e._v(" "),_("h2",{attrs:{id:"tou8a"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toU8a")]),e._v("(isBare?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v(" "),_("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uand"}})]),e._v(" "),_("h2",{attrs:{id:"uand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ucmp"}})]),e._v(" "),_("h2",{attrs:{id:"ucmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ucmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"umod"}})]),e._v(" "),_("h2",{attrs:{id:"umod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("umod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.umod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uor"}})]),e._v(" "),_("h2",{attrs:{id:"uor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushln"}})]),e._v(" "),_("h2",{attrs:{id:"ushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushrn"}})]),e._v(" "),_("h2",{attrs:{id:"ushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uxor"}})]),e._v(" "),_("h2",{attrs:{id:"uxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"xor"}})]),e._v(" "),_("h2",{attrs:{id:"xor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("xor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.xor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"zerobits"}})]),e._v(" "),_("h2",{attrs:{id:"zerobits"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("zeroBits")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeabstracint"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),_("em",[_("code",[e._v("boolean")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),_("tr",[_("td",[e._v("bitLength")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),_("tr",[_("td",[e._v("isNegative")]),e._v(" "),_("td",[_("code",[e._v("boolean")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isbn"}})]),e._v(" "),_("h2",{attrs:{id:"static-isbn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" isBN")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isBN")]),e._v("(b: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"max"}})]),e._v(" "),_("h2",{attrs:{id:"static-max"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" max")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("max")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.max")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"min"}})]),e._v(" "),_("h2",{attrs:{id:"static-min"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" min")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("min")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.min")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mont"}})]),e._v(" "),_("h2",{attrs:{id:"static-mont"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" mont")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mont")]),e._v("(num: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mont")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("num")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"red"}})]),e._v(" "),_("h2",{attrs:{id:"static-red"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" red")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("red")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.red")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/256.aebda57b.js b/docs/assets/js/256.aebda57b.js deleted file mode 100644 index 9b99206ad2..0000000000 --- a/docs/assets/js/256.aebda57b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[256],{329:function(e,t,_){"use strict";_.r(t);var v=_(46),r=Object(v.a)({},function(){var e=this,t=e.$createElement,_=e._self._c||t;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("p",[_("em",[_("strong",[e._v("name")])]),e._v(": BalanceOf")]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The Substrate BalanceOf representation as a "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")]),e._v(".")],1),e._v(" "),_("h1",{attrs:{id:"hierarchy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),_("p",[e._v("↳ "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[e._v("Balance")])],1),e._v(" "),_("p",[_("strong",[e._v("↳ BalanceOf")])]),e._v(" "),_("h1",{attrs:{id:"implements"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),_("ul",[_("li",[_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),_("h1",{attrs:{id:"constructors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),_("p",[_("a",{attrs:{id:"constructor"}})]),e._v(" "),_("h2",{attrs:{id:"constructor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),_("p",[e._v("⊕ "),_("strong",[e._v("new BalanceOf")]),e._v("(value?: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[e._v("BalanceOf")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[e._v("U128")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U128.ts:14"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[e._v("BalanceOf")])],1),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"accessors"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),_("p",[_("a",{attrs:{id:"encodedlength"}})]),e._v(" "),_("h2",{attrs:{id:"encodedlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),_("p",[_("strong",[e._v("get encodedLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isempty"}})]),e._v(" "),_("h2",{attrs:{id:"isempty"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),_("p",[_("strong",[e._v("get isEmpty")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("h1",{attrs:{id:"methods"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),_("p",[_("a",{attrs:{id:"abs"}})]),e._v(" "),_("h2",{attrs:{id:"abs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("abs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.abs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"add"}})]),e._v(" "),_("h2",{attrs:{id:"add"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("add")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.add")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"addn"}})]),e._v(" "),_("h2",{attrs:{id:"addn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("addn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.addn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"and"}})]),e._v(" "),_("h2",{attrs:{id:"and"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("and")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.and")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"andln"}})]),e._v(" "),_("h2",{attrs:{id:"andln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("andln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.andln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and (NOTE: "),_("code",[e._v("andln")]),e._v(" is going to be replaced with "),_("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bincn"}})]),e._v(" "),_("h2",{attrs:{id:"bincn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bincn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": add "),_("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bitlength"}})]),e._v(" "),_("h2",{attrs:{id:"bitlength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("bitLength")]),e._v("(): "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"bytelength"}})]),e._v(" "),_("h2",{attrs:{id:"bytelength"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("byteLength")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"clone"}})]),e._v(" "),_("h2",{attrs:{id:"clone"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("clone")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.clone")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmp"}})]),e._v(" "),_("h2",{attrs:{id:"cmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"cmpn"}})]),e._v(" "),_("h2",{attrs:{id:"cmpn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("cmpn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"div"}})]),e._v(" "),_("h2",{attrs:{id:"div"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("div")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.div")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divround"}})]),e._v(" "),_("h2",{attrs:{id:"divround"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divRound")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"divn"}})]),e._v(" "),_("h2",{attrs:{id:"divn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("divn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.divn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"egcd"}})]),e._v(" "),_("h2",{attrs:{id:"egcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("egcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("object")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Extended GCD results "),_("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("object")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eq"}})]),e._v(" "),_("h2",{attrs:{id:"eq"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eq")]),e._v("(other?: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.eq")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"eqn"}})]),e._v(" "),_("h2",{attrs:{id:"eqn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("eqn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"fromtwos"}})]),e._v(" "),_("h2",{attrs:{id:"fromtwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("fromTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gcd"}})]),e._v(" "),_("h2",{attrs:{id:"gcd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gcd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gt"}})]),e._v(" "),_("h2",{attrs:{id:"gt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gte"}})]),e._v(" "),_("h2",{attrs:{id:"gte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gten"}})]),e._v(" "),_("h2",{attrs:{id:"gten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"gtn"}})]),e._v(" "),_("h2",{attrs:{id:"gtn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("gtn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iabs"}})]),e._v(" "),_("h2",{attrs:{id:"iabs"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iabs")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iadd"}})]),e._v(" "),_("h2",{attrs:{id:"iadd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iadd")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iaddn"}})]),e._v(" "),_("h2",{attrs:{id:"iaddn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iaddn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iand"}})]),e._v(" "),_("h2",{attrs:{id:"iand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"idivn"}})]),e._v(" "),_("h2",{attrs:{id:"idivn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("idivn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imaskn"}})]),e._v(" "),_("h2",{attrs:{id:"imaskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imaskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imul"}})]),e._v(" "),_("h2",{attrs:{id:"imul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"imuln"}})]),e._v(" "),_("h2",{attrs:{id:"imuln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("imuln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ineg"}})]),e._v(" "),_("h2",{attrs:{id:"ineg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ineg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"inotn"}})]),e._v(" "),_("h2",{attrs:{id:"inotn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("inotn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"invm"}})]),e._v(" "),_("h2",{attrs:{id:"invm"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("invm")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.invm")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": inverse "),_("code",[e._v("a")]),e._v(" modulo "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ior"}})]),e._v(" "),_("h2",{attrs:{id:"ior"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ior")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ior")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iseven"}})]),e._v(" "),_("h2",{attrs:{id:"iseven"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isEven")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isneg"}})]),e._v(" "),_("h2",{attrs:{id:"isneg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isNeg")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isodd"}})]),e._v(" "),_("h2",{attrs:{id:"isodd"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isOdd")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iszero"}})]),e._v(" "),_("h2",{attrs:{id:"iszero"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isZero")]),e._v("(): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishln"}})]),e._v(" "),_("h2",{attrs:{id:"ishln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ishrn"}})]),e._v(" "),_("h2",{attrs:{id:"ishrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ishrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),_("OutboundLink")],1),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isqr"}})]),e._v(" "),_("h2",{attrs:{id:"isqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isub"}})]),e._v(" "),_("h2",{attrs:{id:"isub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isubn"}})]),e._v(" "),_("h2",{attrs:{id:"isubn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isubn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuand"}})]),e._v(" "),_("h2",{attrs:{id:"iuand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuor"}})]),e._v(" "),_("h2",{attrs:{id:"iuor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushln"}})]),e._v(" "),_("h2",{attrs:{id:"iushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iushrn"}})]),e._v(" "),_("h2",{attrs:{id:"iushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"iuxor"}})]),e._v(" "),_("h2",{attrs:{id:"iuxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("iuxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ixor"}})]),e._v(" "),_("h2",{attrs:{id:"ixor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ixor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lt"}})]),e._v(" "),_("h2",{attrs:{id:"lt"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lt")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lte"}})]),e._v(" "),_("h2",{attrs:{id:"lte"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lte")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lte")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"lten"}})]),e._v(" "),_("h2",{attrs:{id:"lten"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("lten")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.lten")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ltn"}})]),e._v(" "),_("h2",{attrs:{id:"ltn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ltn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"maskn"}})]),e._v(" "),_("h2",{attrs:{id:"maskn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("maskn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mod"}})]),e._v(" "),_("h2",{attrs:{id:"mod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"modn"}})]),e._v(" "),_("h2",{attrs:{id:"modn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("modn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.modn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("see")])]),e._v(": API consistency "),_("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),_("OutboundLink")],1)]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mul"}})]),e._v(" "),_("h2",{attrs:{id:"mul"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mul")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mul")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"muln"}})]),e._v(" "),_("h2",{attrs:{id:"muln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("muln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.muln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"neg"}})]),e._v(" "),_("h2",{attrs:{id:"neg"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("neg")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.neg")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"notn"}})]),e._v(" "),_("h2",{attrs:{id:"notn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("notn")]),e._v("(w: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.notn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": not (for the width specified by "),_("code",[e._v("w")]),e._v(")")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("w")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"or"}})]),e._v(" "),_("h2",{attrs:{id:"or"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("or")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.or")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"pow"}})]),e._v(" "),_("h2",{attrs:{id:"pow"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("pow")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.pow")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": raise "),_("code",[e._v("a")]),e._v(" to the power of "),_("code",[e._v("b")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"setn"}})]),e._v(" "),_("h2",{attrs:{id:"setn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("setn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.setn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shln"}})]),e._v(" "),_("h2",{attrs:{id:"shln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"shrn"}})]),e._v(" "),_("h2",{attrs:{id:"shrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("shrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sqr"}})]),e._v(" "),_("h2",{attrs:{id:"sqr"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sqr")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"sub"}})]),e._v(" "),_("h2",{attrs:{id:"sub"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("sub")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.sub")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"subn"}})]),e._v(" "),_("h2",{attrs:{id:"subn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("subn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.subn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"testn"}})]),e._v(" "),_("h2",{attrs:{id:"testn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("testn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.testn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarray"}})]),e._v(" "),_("h2",{attrs:{id:"toarray"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArray")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"toarraylike"}})]),e._v(" "),_("h2",{attrs:{id:"toarraylike"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("object")])]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),_("em",[_("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to an instance of "),_("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("object")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("ArrayType")]),e._v(" "),_("td",[_("code",[e._v("any")]),e._v("[]")])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")]),e._v("[]")]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobn"}})]),e._v(" "),_("h2",{attrs:{id:"tobn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBn")]),e._v("(): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tobuffer"}})]),e._v(" "),_("h2",{attrs:{id:"tobuffer"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toBuffer")]),e._v("(endian?: "),_("em",[_("code",[e._v("Endianness")])]),e._v(", length?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("Buffer")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),_("td",[_("code",[e._v("Endianness")])])]),e._v(" "),_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Buffer")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tohex"}})]),e._v(" "),_("h2",{attrs:{id:"tohex"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toHex")]),e._v("(): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tojson"}})]),e._v(" "),_("h2",{attrs:{id:"tojson"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toJSON")]),e._v("(): "),_("code",[e._v("any")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("any")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tonumber"}})]),e._v(" "),_("h2",{attrs:{id:"tonumber"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toNumber")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tored"}})]),e._v(" "),_("h2",{attrs:{id:"tored"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toRed")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("ReductionContext")])]),e._v("): "),_("code",[e._v("RedBN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("ReductionContext")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("RedBN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tostring"}})]),e._v(" "),_("h2",{attrs:{id:"tostring"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toString")]),e._v("(base?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),_("p",[_("em",[e._v("Overrides BN.toString")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("number")])]),e._v(" "),_("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"totwos"}})]),e._v(" "),_("h2",{attrs:{id:"totwos"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toTwos")]),e._v("(width: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("width")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"tou8a"}})]),e._v(" "),_("h2",{attrs:{id:"tou8a"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("toU8a")]),e._v("(isBare?: "),_("em",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v("): "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("p",[_("em",[e._v("Implementation of "),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),_("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Inherited from "),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),_("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),_("p",[_("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")]),e._v(" "),_("th",[e._v("Description")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[_("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),_("td",[_("code",[e._v("undefined")]),e._v(" | "),_("code",[e._v("false")]),e._v(" | "),_("code",[e._v("true")])]),e._v(" "),_("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("Uint8Array")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uand"}})]),e._v(" "),_("h2",{attrs:{id:"uand"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uand")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uand")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ucmp"}})]),e._v(" "),_("h2",{attrs:{id:"ucmp"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ucmp")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": compare numbers and return "),_("code",[e._v("-1 (a < b)")]),e._v(", "),_("code",[e._v("0 (a == b)")]),e._v(", or "),_("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("-1")]),e._v(" | "),_("code",[e._v("0")]),e._v(" | "),_("code",[e._v("1")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"umod"}})]),e._v(" "),_("h2",{attrs:{id:"umod"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("umod")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.umod")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uor"}})]),e._v(" "),_("h2",{attrs:{id:"uor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushln"}})]),e._v(" "),_("h2",{attrs:{id:"ushln"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushln")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"ushrn"}})]),e._v(" "),_("h2",{attrs:{id:"ushrn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ushrn")]),e._v("(b: "),_("em",[_("code",[e._v("number")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("number")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"uxor"}})]),e._v(" "),_("h2",{attrs:{id:"uxor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("uxor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"xor"}})]),e._v(" "),_("h2",{attrs:{id:"xor"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("xor")]),e._v("(b: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.xor")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"zerobits"}})]),e._v(" "),_("h2",{attrs:{id:"zerobits"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("zeroBits")]),e._v("(): "),_("code",[e._v("number")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("number")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),_("h2",{attrs:{id:"static-decodeabstracint"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),_("em",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),_("em",[_("code",[e._v("boolean")])]),e._v("): "),_("code",[e._v("string")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),_("p",[_("em",[e._v("Defined in "),_("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),_("OutboundLink")],1)])]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("value")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),_("tr",[_("td",[e._v("bitLength")]),e._v(" "),_("td",[_("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),_("tr",[_("td",[e._v("isNegative")]),e._v(" "),_("td",[_("code",[e._v("boolean")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("string")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"isbn"}})]),e._v(" "),_("h2",{attrs:{id:"static-isbn"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" isBN")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("isBN")]),e._v("(b: "),_("em",[_("code",[e._v("any")])]),e._v("): "),_("code",[e._v("boolean")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("b")]),e._v(" "),_("td",[_("code",[e._v("any")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("boolean")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"max"}})]),e._v(" "),_("h2",{attrs:{id:"static-max"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" max")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("max")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.max")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"min"}})]),e._v(" "),_("h2",{attrs:{id:"static-min"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" min")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("min")]),e._v("(left: "),_("em",[_("code",[e._v("BN")])]),e._v(", right: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("BN")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.min")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("left")]),e._v(" "),_("td",[_("code",[e._v("BN")])])]),e._v(" "),_("tr",[_("td",[e._v("right")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("BN")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"mont"}})]),e._v(" "),_("h2",{attrs:{id:"static-mont"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" mont")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("mont")]),e._v("(num: "),_("em",[_("code",[e._v("BN")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.mont")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("num")]),e._v(" "),_("td",[_("code",[e._v("BN")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr"),e._v(" "),_("p",[_("a",{attrs:{id:"red"}})]),e._v(" "),_("h2",{attrs:{id:"static-red"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),_("code",[e._v("")]),e._v(" red")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("red")]),e._v("(reductionContext: "),_("em",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])]),e._v("): "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("p",[_("em",[e._v("Inherited from BN.red")])]),e._v(" "),_("p",[_("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),_("p",[_("em",[_("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),_("p",[_("strong",[e._v("Parameters:")])]),e._v(" "),_("table",[_("thead",[_("tr",[_("th",[e._v("Name")]),e._v(" "),_("th",[e._v("Type")])])]),e._v(" "),_("tbody",[_("tr",[_("td",[e._v("reductionContext")]),e._v(" "),_("td",[_("code",[e._v("BN")]),e._v(" | "),_("code",[e._v("IPrimeName")])])])])]),e._v(" "),_("p",[_("strong",[e._v("Returns:")]),e._v(" "),_("code",[e._v("ReductionContext")])]),e._v(" "),_("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/257.6c8ec712.js b/docs/assets/js/257.6c8ec712.js deleted file mode 100644 index a2a3abed4d..0000000000 --- a/docs/assets/js/257.6c8ec712.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[257],{327:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": BftAuthoritySignature")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ BftAuthoritySignature")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new BftAuthoritySignature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_type_bft_.html#bftauthoritysignaturevalue"}},[e._v("BftAuthoritySignatureValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[e._v("BftAuthoritySignature")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Bft.ts:20"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_type_bft_.html#bftauthoritysignaturevalue"}},[e._v("BftAuthoritySignatureValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[e._v("BftAuthoritySignature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"authorityid"}})]),e._v(" "),r("h2",{attrs:{id:"authorityid"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#authorityid","aria-hidden":"true"}},[e._v("#")]),e._v(" authorityId")]),e._v(" "),r("p",[r("strong",[e._v("get authorityId")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[e._v("AuthorityId")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Bft.ts:31"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The wrapped [[AuthoriyId]]")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[e._v("AuthorityId")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"signature"}})]),e._v(" "),r("h2",{attrs:{id:"signature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signature","aria-hidden":"true"}},[e._v("#")]),e._v(" signature")]),e._v(" "),r("p",[r("strong",[e._v("get signature")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Bft.ts:38"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")]),e._v(" value")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/258.87f76ceb.js b/docs/assets/js/258.87f76ceb.js deleted file mode 100644 index cd0d6dc800..0000000000 --- a/docs/assets/js/258.87f76ceb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[258],{326:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": BftHashSignature")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour.")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ BftHashSignature")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new BftHashSignature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_type_bft_.html#bfthashsignaturevalue"}},[e._v("BftHashSignatureValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[e._v("BftHashSignature")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Bft.ts:51"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_type_bft_.html#bfthashsignaturevalue"}},[e._v("BftHashSignatureValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[e._v("BftHashSignature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),e._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[e._v("#")]),e._v(" hash")]),e._v(" "),r("p",[r("strong",[e._v("get hash")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Bft.ts:62"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"signature"}})]),e._v(" "),r("h2",{attrs:{id:"signature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signature","aria-hidden":"true"}},[e._v("#")]),e._v(" signature")]),e._v(" "),r("p",[r("strong",[e._v("get signature")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Bft.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/259.2e0368b6.js b/docs/assets/js/259.2e0368b6.js deleted file mode 100644 index e22cf2bbb4..0000000000 --- a/docs/assets/js/259.2e0368b6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[259],{586:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Block")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A block encoded with header and extrinsics")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Block")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Block")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_type_block_.html#blockvalue"}},[t._v("BlockValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Block.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_type_block_.html#blockvalue"}},[t._v("BlockValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"contenthash"}})]),t._v(" "),r("h2",{attrs:{id:"contenthash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#contenthash","aria-hidden":"true"}},[t._v("#")]),t._v(" contentHash")]),t._v(" "),r("p",[r("strong",[t._v("get contentHash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Block.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes a content "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")]),t._v(" for the block")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"extrinsics"}})]),t._v(" "),r("h2",{attrs:{id:"extrinsics"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extrinsics","aria-hidden":"true"}},[t._v("#")]),t._v(" extrinsics")]),t._v(" "),r("p",[r("strong",[t._v("get extrinsics")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("Extrinsics")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Block.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("Extrinsics")]),t._v(" contained in the block")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("Extrinsics")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),t._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),r("p",[r("strong",[t._v("get hash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Block.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Block/header "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"header"}})]),t._v(" "),r("h2",{attrs:{id:"header"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#header","aria-hidden":"true"}},[t._v("#")]),t._v(" header")]),t._v(" "),r("p",[r("strong",[t._v("get header")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Block.ts:58"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v(" of the block")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/26.7808132a.js b/docs/assets/js/26.7808132a.js deleted file mode 100644 index 9fe98cbdbf..0000000000 --- a/docs/assets/js/26.7808132a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{360:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"bestnumberfinalised"}})]),t._v(" "),n("h2",{attrs:{id:"bestnumberfinalised"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#bestnumberfinalised","aria-hidden":"true"}},[t._v("#")]),t._v(" bestNumberFinalised")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("bestNumberFinalised")]),t._v("(api: "),n("em",[n("code",[t._v("ApiInterface$Rx")])]),t._v("): "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/bestNumberFinalised.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("chain/bestNumberFinalised.ts:23"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Get the latest finalised block number. example")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[t._v("api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumberFinalised")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`the current finalised block is #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("api")]),t._v(" "),n("td",[n("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/260.2248090b.js b/docs/assets/js/260.2248090b.js deleted file mode 100644 index d63302bc7b..0000000000 --- a/docs/assets/js/260.2248090b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[260],{325:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": BlockNumber")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": A representation of a Substrate BlockNumber, implemented as a "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ BlockNumber")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new BlockNumber")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[e._v("BlockNumber")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U64.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[e._v("BlockNumber")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/261.08c9df99.js b/docs/assets/js/261.08c9df99.js deleted file mode 100644 index a3f41cbb48..0000000000 --- a/docs/assets/js/261.08c9df99.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[261],{419:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": CodeHash")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The default contract code hash that is used accross the system. It is a wrapper around "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")]),e._v(", representing a 32-byte blake2b (Substrate) value")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ CodeHash")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new CodeHash")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[e._v("CodeHash")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H256.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[e._v("CodeHash")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/262.3ff926a4.js b/docs/assets/js/262.3ff926a4.js deleted file mode 100644 index 69ef590f45..0000000000 --- a/docs/assets/js/262.3ff926a4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[262],{324:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": AuthoritiesChange")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Log for Authories changed")]),e._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"t-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ AuthoritiesChange")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("T")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new AuthoritiesChange")]),e._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[e._v("AuthoritiesChange")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v(" "),r("td",[e._v("[] as Array")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[e._v("AuthoritiesChange")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" Type")]),e._v(" "),r("p",[r("strong",[e._v("get Type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#type"}},[e._v("Type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:66"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The type for the items")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:82"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:90"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("T")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:173"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-t"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-t","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(_other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#indexof"}},[e._v("indexOf")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:97"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Finds the index of the value in the array")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" _other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:182"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:115"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:122"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:129"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:138"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:151"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodevector"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodevector"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodevector","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeVector")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeVector")]),e._v("<"),r("code",[e._v("T")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#decodevector"}},[e._v("decodeVector")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"t-codec-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec-2","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1)]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("O")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"o-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" O : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/263.45570ce9.js b/docs/assets/js/263.45570ce9.js deleted file mode 100644 index 8e3ce3ab6f..0000000000 --- a/docs/assets/js/263.45570ce9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[263],{416:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": ChangesTrieRoot")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Log for changes to the Trie root")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ChangesTrieRoot")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ChangesTrieRoot")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[e._v("ChangesTrieRoot")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H256.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[e._v("ChangesTrieRoot")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/264.41f7177f.js b/docs/assets/js/264.41f7177f.js deleted file mode 100644 index 3af5756b80..0000000000 --- a/docs/assets/js/264.41f7177f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[264],{583:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Digest")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v(" Digest")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Digest")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Digest")]),t._v("(value: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L117",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Digest.ts:117"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"logs"}})]),t._v(" "),r("h2",{attrs:{id:"logs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#logs","aria-hidden":"true"}},[t._v("#")]),t._v(" logs")]),t._v(" "),r("p",[r("strong",[t._v("get logs")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[t._v("DigestItem")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L127",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Digest.ts:127"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[t._v("DigestItem")]),t._v(" logs")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[t._v("DigestItem")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/265.a1c048fa.js b/docs/assets/js/265.a1c048fa.js deleted file mode 100644 index 8f85f1f61e..0000000000 --- a/docs/assets/js/265.a1c048fa.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[265],{580:function(e,t,s){"use strict";s.r(t);var r=s(46),_=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("p",[s("em",[s("strong",[e._v("name")])]),e._v(": DigestItem")]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": A "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v(" the specifies the specific item in the logs of a "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[e._v("Digest")])],1),e._v(" "),s("h1",{attrs:{id:"hierarchy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),s("p",[e._v("↳ "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[e._v("AuthoritiesChange")]),e._v(" | "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[e._v("ChangesTrieRoot")]),e._v(" | "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[e._v("Other")]),e._v(" | "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[e._v("Seal")]),e._v(">")],1),e._v(" "),s("p",[s("strong",[e._v("↳ DigestItem")])]),e._v(" "),s("h1",{attrs:{id:"implements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),s("h1",{attrs:{id:"constructors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),s("p",[s("a",{attrs:{id:"constructor"}})]),e._v(" "),s("h2",{attrs:{id:"constructor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),s("p",[e._v("⊕ "),s("strong",[e._v("new DigestItem")]),e._v("(value: "),s("em",[s("code",[e._v("any")])]),e._v("): "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[e._v("DigestItem")])],1),e._v(" "),s("p",[s("em",[e._v("Overrides "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:73"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("strong",[e._v("Parameters:")])]),e._v(" "),s("table",[s("thead",[s("tr",[s("th",[e._v("Name")]),e._v(" "),s("th",[e._v("Type")])])]),e._v(" "),s("tbody",[s("tr",[s("td",[e._v("value")]),e._v(" "),s("td",[s("code",[e._v("any")])])])])]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[e._v("DigestItem")])],1),e._v(" "),s("hr"),e._v(" "),s("h1",{attrs:{id:"accessors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),s("p",[s("a",{attrs:{id:"asauthoritieschange"}})]),e._v(" "),s("h2",{attrs:{id:"asauthoritieschange"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asauthoritieschange","aria-hidden":"true"}},[e._v("#")]),e._v(" asAuthoritiesChange")]),e._v(" "),s("p",[s("strong",[e._v("get asAuthoritiesChange")]),e._v("(): "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[e._v("AuthoritiesChange")])],1),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:86"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[e._v("AuthoritiesChange")])],1),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[e._v("AuthoritiesChange")])],1),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"aschangestrieroot"}})]),e._v(" "),s("h2",{attrs:{id:"aschangestrieroot"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#aschangestrieroot","aria-hidden":"true"}},[e._v("#")]),e._v(" asChangesTrieRoot")]),e._v(" "),s("p",[s("strong",[e._v("get asChangesTrieRoot")]),e._v("(): "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[e._v("ChangesTrieRoot")])],1),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:93"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[e._v("ChangesTrieRoot")])],1),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[e._v("ChangesTrieRoot")])],1),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"asother"}})]),e._v(" "),s("h2",{attrs:{id:"asother"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asother","aria-hidden":"true"}},[e._v("#")]),e._v(" asOther")]),e._v(" "),s("p",[s("strong",[e._v("get asOther")]),e._v("(): "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[e._v("Other")])],1),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L100",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:100"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[e._v("Other")])],1),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[e._v("Other")])],1),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"asseal"}})]),e._v(" "),s("h2",{attrs:{id:"asseal"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#asseal","aria-hidden":"true"}},[e._v("#")]),e._v(" asSeal")]),e._v(" "),s("p",[s("strong",[e._v("get asSeal")]),e._v("(): "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[e._v("Seal")])],1),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:107"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Returns the item as a "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[e._v("Seal")])],1),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[e._v("Seal")])],1),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"encodedlength"}})]),e._v(" "),s("h2",{attrs:{id:"encodedlength"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),s("p",[s("strong",[e._v("get encodedLength")]),e._v("(): "),s("code",[e._v("number")])]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:114"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("number")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"index"}})]),e._v(" "),s("h2",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),s("p",[s("strong",[e._v("get index")]),e._v("(): "),s("code",[e._v("number")])]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[e._v("index")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:121"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": The index of the metadata value")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("number")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"isempty"}})]),e._v(" "),s("h2",{attrs:{id:"isempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),s("p",[s("strong",[e._v("get isEmpty")]),e._v("(): "),s("code",[e._v("boolean")])]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:128"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("boolean")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"isnone"}})]),e._v(" "),s("h2",{attrs:{id:"isnone"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[e._v("#")]),e._v(" isNone")]),e._v(" "),s("p",[s("strong",[e._v("get isNone")]),e._v("(): "),s("code",[e._v("boolean")])]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[e._v("isNone")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:135"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type")],1),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("boolean")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"isnull"}})]),e._v(" "),s("h2",{attrs:{id:"isnull"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[e._v("#")]),e._v(" isNull")]),e._v(" "),s("p",[s("strong",[e._v("get isNull")]),e._v("(): "),s("code",[e._v("boolean")])]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[e._v("isNull")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:142"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type (deprecated, use isNone)")],1),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("boolean")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"type"}})]),e._v(" "),s("h2",{attrs:{id:"type"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" type")]),e._v(" "),s("p",[s("strong",[e._v("get type")]),e._v("(): "),s("code",[e._v("string")])]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[e._v("type")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:149"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": The name of the type this enum value represents")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("string")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"value"}})]),e._v(" "),s("h2",{attrs:{id:"value"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),s("p",[s("strong",[e._v("get value")]),e._v("(): "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[e._v("value")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:156"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": The value of the enum")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),s("hr"),e._v(" "),s("h1",{attrs:{id:"methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),s("p",[s("a",{attrs:{id:"eq"}})]),e._v(" "),s("h2",{attrs:{id:"eq"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("eq")]),e._v("(other?: "),s("em",[s("code",[e._v("any")])]),e._v("): "),s("code",[e._v("boolean")])]),e._v(" "),s("p",[s("em",[e._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[e._v("eq")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:163"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),s("p",[s("strong",[e._v("Parameters:")])]),e._v(" "),s("table",[s("thead",[s("tr",[s("th",[e._v("Name")]),e._v(" "),s("th",[e._v("Type")])])]),e._v(" "),s("tbody",[s("tr",[s("td",[s("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),s("td",[s("code",[e._v("any")])])])])]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("boolean")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"tohex"}})]),e._v(" "),s("h2",{attrs:{id:"tohex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("toHex")]),e._v("(): "),s("code",[e._v("string")])]),e._v(" "),s("p",[s("em",[e._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:176"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("string")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"tojson"}})]),e._v(" "),s("h2",{attrs:{id:"tojson"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("toJSON")]),e._v("(): "),s("code",[e._v("any")])]),e._v(" "),s("p",[s("em",[e._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:183"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("any")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"tonumber"}})]),e._v(" "),s("h2",{attrs:{id:"tonumber"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("toNumber")]),e._v("(): "),s("code",[e._v("number")])]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:192"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("number")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"tostring"}})]),e._v(" "),s("h2",{attrs:{id:"tostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("toString")]),e._v("(): "),s("code",[e._v("string")])]),e._v(" "),s("p",[s("em",[e._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:199"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("string")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"tou8a"}})]),e._v(" "),s("h2",{attrs:{id:"tou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("toU8a")]),e._v("(isBare?: "),s("em",[s("code",[e._v("undefined")]),e._v(" | "),s("code",[e._v("false")]),e._v(" | "),s("code",[e._v("true")])]),e._v("): "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("p",[s("em",[e._v("Implementation of "),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),s("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:209"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("em",[s("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),s("p",[s("strong",[e._v("Parameters:")])]),e._v(" "),s("table",[s("thead",[s("tr",[s("th",[e._v("Name")]),e._v(" "),s("th",[e._v("Type")]),e._v(" "),s("th",[e._v("Description")])])]),e._v(" "),s("tbody",[s("tr",[s("td",[s("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),s("td",[s("code",[e._v("undefined")]),e._v(" | "),s("code",[e._v("false")]),e._v(" | "),s("code",[e._v("true")])]),e._v(" "),s("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("Uint8Array")])]),e._v(" "),s("hr"),e._v(" "),s("p",[s("a",{attrs:{id:"with"}})]),e._v(" "),s("h2",{attrs:{id:"static-with"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),s("code",[e._v("")]),e._v(" with")]),e._v(" "),s("p",[e._v("▸ "),s("strong",[e._v("with")]),e._v("<"),s("code",[e._v("S")]),e._v(">(Types: "),s("em",[s("code",[e._v("S")])]),e._v("): "),s("code",[e._v("EnumConstructor")]),e._v("<"),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),s("code",[e._v("S")]),e._v(">>")],1),e._v(" "),s("p",[s("em",[e._v("Inherited from "),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[e._v("with")])],1)]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:101"),s("OutboundLink")],1)])]),e._v(" "),s("p",[s("strong",[e._v("Type parameters:")])]),e._v(" "),s("h4",{attrs:{id:"s-constructordef"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),s("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[e._v("ConstructorDef")])],1),e._v(" "),s("p",[s("strong",[e._v("Parameters:")])]),e._v(" "),s("table",[s("thead",[s("tr",[s("th",[e._v("Name")]),e._v(" "),s("th",[e._v("Type")])])]),e._v(" "),s("tbody",[s("tr",[s("td",[e._v("Types")]),e._v(" "),s("td",[s("code",[e._v("S")])])])])]),e._v(" "),s("p",[s("strong",[e._v("Returns:")]),e._v(" "),s("code",[e._v("EnumConstructor")]),e._v("<"),s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),s("code",[e._v("S")]),e._v(">>")],1),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/266.3c3e4de7.js b/docs/assets/js/266.3c3e4de7.js deleted file mode 100644 index 68a042008d..0000000000 --- a/docs/assets/js/266.3c3e4de7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[266],{413:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Other")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Log item that is just a stream of "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Other")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Other")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[e._v("Other")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[e._v("Other")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:61"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/267.3098152d.js b/docs/assets/js/267.3098152d.js deleted file mode 100644 index 30f4f1a0be..0000000000 --- a/docs/assets/js/267.3098152d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[267],{323:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Seal")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Log item indicating a sealing event")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Seal")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Seal")]),e._v("(value: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[e._v("Seal")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:44"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[e._v("Seal")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"signature"}})]),e._v(" "),r("h2",{attrs:{id:"signature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signature","aria-hidden":"true"}},[e._v("#")]),e._v(" signature")]),e._v(" "),r("p",[r("strong",[e._v("get signature")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:55"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slot"}})]),e._v(" "),r("h2",{attrs:{id:"slot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slot","aria-hidden":"true"}},[e._v("#")]),e._v(" slot")]),e._v(" "),r("p",[r("strong",[e._v("get slot")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Digest.ts:62"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")]),e._v(" slot")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/268.6741a34e.js b/docs/assets/js/268.6741a34e.js deleted file mode 100644 index c9f31cd933..0000000000 --- a/docs/assets/js/268.6741a34e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[268],{577:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Event")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A representation of a system event. These are generated via the "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")]),t._v(" interfaces and specific to a specific Substrate runtime")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Event")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Event")]),t._v("(_value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:86"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" _value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("get data")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("EventData")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L144",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:144"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("EventData")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("EventData")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),t._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" index")]),t._v(" "),r("p",[r("strong",[t._v("get index")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[t._v("EventIndex")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L151",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:151"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[t._v("EventIndex")]),t._v(", identifying the raw event")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[t._v("EventIndex")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"meta"}})]),t._v(" "),r("h2",{attrs:{id:"meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),r("p",[r("strong",[t._v("get meta")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L158",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:158"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")]),t._v(" with the documentation")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"method"}})]),t._v(" "),r("h2",{attrs:{id:"method"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),r("p",[r("strong",[t._v("get method")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L165",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:165"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The method string identifying the event")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"section"}})]),t._v(" "),r("h2",{attrs:{id:"section"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#section","aria-hidden":"true"}},[t._v("#")]),t._v(" section")]),t._v(" "),r("p",[r("strong",[t._v("get section")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L172",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:172"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The section string identifying the event")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"typedef"}})]),t._v(" "),r("h2",{attrs:{id:"typedef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#typedef","aria-hidden":"true"}},[t._v("#")]),t._v(" typeDef")]),t._v(" "),r("p",[r("strong",[t._v("get typeDef")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[t._v("TypeDef")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L179",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:179"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[t._v("TypeDef")]),t._v(" for the event")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[t._v("TypeDef")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeevent"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeevent"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeevent","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeEvent")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeEvent")]),t._v("(value?: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("object")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:98"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])]),t._v(" "),r("td",[t._v("new Uint8Array()")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("object")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"injectmetadata"}})]),t._v(" "),r("h2",{attrs:{id:"static-injectmetadata"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-injectmetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" injectMetadata")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("injectMetadata")]),t._v("(metadata: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Event.ts:122"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("metadata")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/269.1fd28d56.js b/docs/assets/js/269.1fd28d56.js deleted file mode 100644 index 628cd9c595..0000000000 --- a/docs/assets/js/269.1fd28d56.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[269],{322:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": EventData")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Wrapper for the actual data that forms part of an "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[e._v("Event")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ EventData")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new EventData")]),e._v("(Types: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v(">")],1),e._v(", value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v(", typeDef: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[e._v("TypeDef")]),e._v(">")],1),e._v(", meta: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")])],1),e._v(", section: "),r("em",[r("code",[e._v("string")])]),e._v(", method: "),r("em",[r("code",[e._v("string")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[e._v("EventData")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Event.ts:28"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v(">")],1)]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[e._v("typeDef")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[e._v("TypeDef")]),e._v(">")],1)]),e._v(" "),r("tr",[r("td",[e._v("meta")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")])],1)]),e._v(" "),r("tr",[r("td",[e._v("section")]),e._v(" "),r("td",[r("code",[e._v("string")])])]),e._v(" "),r("tr",[r("td",[e._v("method")]),e._v(" "),r("td",[r("code",[e._v("string")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[e._v("EventData")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"meta"}})]),e._v(" "),r("h2",{attrs:{id:"meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[e._v("#")]),e._v(" meta")]),e._v(" "),r("p",[r("strong",[e._v("get meta")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Event.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[e._v("EventMetadata")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"method"}})]),e._v(" "),r("h2",{attrs:{id:"method"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[e._v("#")]),e._v(" method")]),e._v(" "),r("p",[r("strong",[e._v("get method")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Event.ts:49"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The method as a string")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"section"}})]),e._v(" "),r("h2",{attrs:{id:"section"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#section","aria-hidden":"true"}},[e._v("#")]),e._v(" section")]),e._v(" "),r("p",[r("strong",[e._v("get section")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L56",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Event.ts:56"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The section as a string")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"typedef"}})]),e._v(" "),r("h2",{attrs:{id:"typedef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#typedef","aria-hidden":"true"}},[e._v("#")]),e._v(" typeDef")]),e._v(" "),r("p",[r("strong",[e._v("get typeDef")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[e._v("TypeDef")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Event.ts:63"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The "),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[e._v("TypeDef")]),e._v(" for this event")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[e._v("TypeDef")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/27.fe4b5c14.js b/docs/assets/js/27.fe4b5c14.js deleted file mode 100644 index 36a9d6e070..0000000000 --- a/docs/assets/js/27.fe4b5c14.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{361:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"bestnumberlag"}})]),t._v(" "),s("h2",{attrs:{id:"bestnumberlag"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#bestnumberlag","aria-hidden":"true"}},[t._v("#")]),t._v(" bestNumberLag")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("bestNumberLag")]),t._v("(api: "),s("em",[s("code",[t._v("ApiInterface$Rx")])]),t._v("): "),s("code",[t._v("(Anonymous function)")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/bestNumberLag.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("chain/bestNumberLag.ts:25"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Calculates the lag between finalised head and best head")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[t._v("api"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumberLag")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("lag"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`finalised is ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("lag"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" blocks behind head`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("api")]),t._v(" "),s("td",[s("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("(Anonymous function)")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/270.dcc22e3a.js b/docs/assets/js/270.dcc22e3a.js deleted file mode 100644 index 520a92db80..0000000000 --- a/docs/assets/js/270.dcc22e3a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[270],{410:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": EventIndex")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": This follows the same approach as in "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[e._v("Method")]),e._v(", we have the "),r("code",[e._v("[sectionIndex, methodIndex]")]),e._v(" pairing that indicates the actual event fired")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ EventIndex")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new EventIndex")]),e._v("(value?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[e._v("EventIndex")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Event.ts:74"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[e._v("EventIndex")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/271.3e4a008a.js b/docs/assets/js/271.3e4a008a.js deleted file mode 100644 index f9a7e81472..0000000000 --- a/docs/assets/js/271.3e4a008a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[271],{321:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": ApplyExtrinsic")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The "),v("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[e._v("Phase")]),e._v(" where the extrinsic is applied")],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ ApplyExtrinsic")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new ApplyExtrinsic")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[e._v("ApplyExtrinsic")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[e._v("ApplyExtrinsic")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/272.8d20003e.js b/docs/assets/js/272.8d20003e.js deleted file mode 100644 index f15055eeaa..0000000000 --- a/docs/assets/js/272.8d20003e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[272],{574:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": EventRecord")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A record for an "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")]),t._v(" (as specified by "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")]),t._v(") with the specific "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")]),t._v(" of application.")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ EventRecord")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new EventRecord")]),t._v("(value: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/EventRecord.ts:61"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"event"}})]),t._v(" "),r("h2",{attrs:{id:"event"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#event","aria-hidden":"true"}},[t._v("#")]),t._v(" event")]),t._v(" "),r("p",[r("strong",[t._v("get event")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/EventRecord.ts:72"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")]),t._v(" this record refers to")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"phase"}})]),t._v(" "),r("h2",{attrs:{id:"phase"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#phase","aria-hidden":"true"}},[t._v("#")]),t._v(" phase")]),t._v(" "),r("p",[r("strong",[t._v("get phase")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/EventRecord.ts:79"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")]),t._v(" where the event was generated")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/273.d3ba5b3e.js b/docs/assets/js/273.d3ba5b3e.js deleted file mode 100644 index a191ac21c3..0000000000 --- a/docs/assets/js/273.d3ba5b3e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[273],{563:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Finalization")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")]),t._v(" where the extrinsic is being Finalized")],1),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Finalization")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/274.5faf4627.js b/docs/assets/js/274.5faf4627.js deleted file mode 100644 index 899595a011..0000000000 --- a/docs/assets/js/274.5faf4627.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[274],{571:function(e,t,r){"use strict";r.r(t);var s=r(46),_=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Phase")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v(" that indicates the specific phase where the "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[e._v("EventRecord")]),e._v(" was generated")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[e._v("ApplyExtrinsic")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[e._v("Finalization")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("↳ Phase")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Phase")]),e._v("(value: "),r("em",[r("code",[e._v("any")])]),e._v(", index?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[e._v("Phase")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/EventRecord.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[e._v("Phase")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"asapplyextrinsic"}})]),e._v(" "),r("h2",{attrs:{id:"asapplyextrinsic"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asapplyextrinsic","aria-hidden":"true"}},[e._v("#")]),e._v(" asApplyExtrinsic")]),e._v(" "),r("p",[r("strong",[e._v("get asApplyExtrinsic")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[e._v("ApplyExtrinsic")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/EventRecord.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[e._v("ApplyExtrinsic")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[e._v("ApplyExtrinsic")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"asfinalization"}})]),e._v(" "),r("h2",{attrs:{id:"asfinalization"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asfinalization","aria-hidden":"true"}},[e._v("#")]),e._v(" asFinalization")]),e._v(" "),r("p",[r("strong",[e._v("get asFinalization")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[e._v("Finalization")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/EventRecord.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[e._v("Finalization")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[e._v("Finalization")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[e._v("index")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The index of the metadata value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:128"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),e._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[e._v("#")]),e._v(" isNone")]),e._v(" "),r("p",[r("strong",[e._v("get isNone")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[e._v("isNone")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:135"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnull"}})]),e._v(" "),r("h2",{attrs:{id:"isnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[e._v("#")]),e._v(" isNull")]),e._v(" "),r("p",[r("strong",[e._v("get isNull")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[e._v("isNull")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:142"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type (deprecated, use isNone)")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" type")]),e._v(" "),r("p",[r("strong",[e._v("get type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[e._v("type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The name of the type this enum value represents")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[e._v("value")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:156"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value of the enum")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:163"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:183"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:192"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:199"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:209"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[e._v("ConstructorDef")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/275.6ce9fcd9.js b/docs/assets/js/275.6ce9fcd9.js deleted file mode 100644 index 86a6ca77c4..0000000000 --- a/docs/assets/js/275.6ce9fcd9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[275],{482:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Extrinsic")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Representation of an Extrinsic in the system. It contains the actual call, (optional) signature and encodes with an actual length prefix")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node"),r("OutboundLink")],1),t._v(".")]),t._v(" "),r("p",[t._v("Can be:")]),t._v(" "),r("ul",[r("li",[t._v("signed, to create a transaction")]),t._v(" "),r("li",[t._v("left as is, to create an inherent")])]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Extrinsic")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Extrinsic")]),t._v("(value?: "),r("em",[r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"args"}})]),t._v(" "),r("h2",{attrs:{id:"args"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#args","aria-hidden":"true"}},[t._v("#")]),t._v(" args")]),t._v(" "),r("p",[r("strong",[t._v("get args")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The arguments passed to for the call, exposes args so it is compatible with "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"callindex"}})]),t._v(" "),r("h2",{attrs:{id:"callindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#callindex","aria-hidden":"true"}},[t._v("#")]),t._v(" callIndex")]),t._v(" "),r("p",[r("strong",[t._v("get callIndex")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:83"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The actual "),r("code",[t._v("[sectionIndex, methodIndex]")]),t._v(" as used in the Method")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("get data")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:90"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The actual data for the Method")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:97"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),t._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),r("p",[r("strong",[t._v("get hash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L106",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:106"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Convernience function, encodes the extrinsic and returns the actual hash")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"issigned"}})]),t._v(" "),r("h2",{attrs:{id:"issigned"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#issigned","aria-hidden":"true"}},[t._v("#")]),t._v(" isSigned")]),t._v(" "),r("p",[r("strong",[t._v("get isSigned")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:115"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": "),r("code",[t._v("true")]),t._v(" id the extrinsic is signed")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),t._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[t._v("#")]),t._v(" length")]),t._v(" "),r("p",[r("strong",[t._v("get length")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:122"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the encoded value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"meta"}})]),t._v(" "),r("h2",{attrs:{id:"meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),r("p",[r("strong",[t._v("get meta")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:129"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")]),t._v(" that describes the extrinsic")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"method"}})]),t._v(" "),r("h2",{attrs:{id:"method"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),r("p",[r("strong",[t._v("get method")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L136",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:136"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v(" this extrinsic wraps")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signature"}})]),t._v(" "),r("h2",{attrs:{id:"signature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signature","aria-hidden":"true"}},[t._v("#")]),t._v(" signature")]),t._v(" "),r("p",[r("strong",[t._v("get signature")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L143",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:143"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"addsignature"}})]),t._v(" "),r("h2",{attrs:{id:"addsignature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addsignature","aria-hidden":"true"}},[t._v("#")]),t._v(" addSignature")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("addSignature")]),t._v("(signer: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1),t._v(", signature: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", nonce: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(", era?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L150",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:150"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Add an "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")]),t._v(" to the extrinsic (already generated)")],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("signer")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1)]),t._v(" "),r("tr",[r("td",[t._v("signature")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("nonce")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1)]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" era")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(account: "),r("em",[r("code",[t._v("KeyringPair")])]),t._v(", options: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#signatureoptions"}},[t._v("SignatureOptions")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L159",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:159"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Sign the extrinsic with a specific keypair")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("account")]),t._v(" "),r("td",[r("code",[t._v("KeyringPair")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#signatureoptions"}},[t._v("SignatureOptions")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L168",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:168"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L175",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:175"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:183"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeextrinsic"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeextrinsic"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeextrinsic","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeExtrinsic")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeExtrinsic")]),t._v("(value: "),r("em",[r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v("): "),r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("number")]),t._v("> | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Extrinsic.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("number")]),t._v("> | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/276.086d7309.js b/docs/assets/js/276.086d7309.js deleted file mode 100644 index 8dad5390a7..0000000000 --- a/docs/assets/js/276.086d7309.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[276],{407:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": ExtrinsicEra")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The era for an extrinsic, indicating either a mortal or immortal extrinsic")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ ExtrinsicEra")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new ExtrinsicEra")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[e._v("ExtrinsicEra")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicEra.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/ExtrinsicEra.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[e._v("ExtrinsicEra")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeextrinsicera"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodeextrinsicera"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeextrinsicera","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeExtrinsicEra")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeExtrinsicEra")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicEra.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/ExtrinsicEra.ts:23"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/277.136cb807.js b/docs/assets/js/277.136cb807.js deleted file mode 100644 index 44779f3cd6..0000000000 --- a/docs/assets/js/277.136cb807.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[277],{317:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Extrinsics")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v(" of "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[e._v("Extrinsic")])],1),e._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"t-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Extrinsics")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html"}},[e._v("PendingExtrinsics")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("T")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Extrinsics")]),e._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[e._v("Extrinsics")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(" "),r("td",[e._v("-")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v(" "),r("td",[e._v("[] as Array")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[e._v("Extrinsics")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" Type")]),e._v(" "),r("p",[r("strong",[e._v("get Type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#type"}},[e._v("Type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:66"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The type for the items")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:82"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("T")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:90"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("T")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:173"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-t"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-t","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(_other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#indexof"}},[e._v("indexOf")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:97"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Finds the index of the value in the array")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" _other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("T")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("T")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:182"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("T")])]),e._v("): "),r("code",[e._v("T")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("T")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:115"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:122"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:129"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:138"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:151"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("code",[e._v("T")]),e._v("[]")]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("T")]),e._v("[]")]),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodevector"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodevector"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodevector","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeVector")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeVector")]),e._v("<"),r("code",[e._v("T")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#decodevector"}},[e._v("decodeVector")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:32"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"t-codec-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-codec-2","aria-hidden":"true"}},[e._v("#")]),e._v(" T : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("T")]),e._v(">")],1)]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("any")]),e._v("> | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("T")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("O")]),e._v(">(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Vector.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"o-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#o-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" O : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Type")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("code",[e._v("O")]),e._v(">")],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[e._v("Vector")]),e._v("<"),r("code",[e._v("O")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/278.9218f102.js b/docs/assets/js/278.9218f102.js deleted file mode 100644 index dcbb00bb16..0000000000 --- a/docs/assets/js/278.9218f102.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[278],{568:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": ExtrinsicSignature")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A container for the "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")]),t._v(" associated with a specific "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ ExtrinsicSignature")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new ExtrinsicSignature")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:29"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L66",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:66"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"era"}})]),t._v(" "),r("h2",{attrs:{id:"era"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#era","aria-hidden":"true"}},[t._v("#")]),t._v(" era")]),t._v(" "),r("p",[r("strong",[t._v("get era")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L82",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:82"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")]),t._v(" (mortal or immortal) this signature applies to")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"issigned"}})]),t._v(" "),r("h2",{attrs:{id:"issigned"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#issigned","aria-hidden":"true"}},[t._v("#")]),t._v(" isSigned")]),t._v(" "),r("p",[r("strong",[t._v("get isSigned")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:75"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": "),r("code",[t._v("true")]),t._v(" if the signature is valid")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"nonce"}})]),t._v(" "),r("h2",{attrs:{id:"nonce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nonce","aria-hidden":"true"}},[t._v("#")]),t._v(" nonce")]),t._v(" "),r("p",[r("strong",[t._v("get nonce")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L89",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:89"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")]),t._v(" for the signature")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signature"}})]),t._v(" "),r("h2",{attrs:{id:"signature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signature","aria-hidden":"true"}},[t._v("#")]),t._v(" signature")]),t._v(" "),r("p",[r("strong",[t._v("get signature")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L96",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:96"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The actuall "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")]),t._v(" hash")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signer"}})]),t._v(" "),r("h2",{attrs:{id:"signer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signer","aria-hidden":"true"}},[t._v("#")]),t._v(" signer")]),t._v(" "),r("p",[r("strong",[t._v("get signer")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L103",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:103"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")]),t._v(" that signed")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"version"}})]),t._v(" "),r("h2",{attrs:{id:"version"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#version","aria-hidden":"true"}},[t._v("#")]),t._v(" version")]),t._v(" "),r("p",[r("strong",[t._v("get version")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:110"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The encoded version for the signature")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"addsignature"}})]),t._v(" "),r("h2",{attrs:{id:"addsignature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addsignature","aria-hidden":"true"}},[t._v("#")]),t._v(" addSignature")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("addSignature")]),t._v("(_signer: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1),t._v(", _signature: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", _nonce: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(", _era?: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L131",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:131"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Adds a raw signature")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("_signer")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[t._v("_signature")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])]),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[t._v("_nonce")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" _era")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])]),t._v(" "),r("td",[t._v("IMMORTAL_ERA")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(method: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(", account: "),r("em",[r("code",[t._v("KeyringPair")])]),t._v(", __namedParameters: "),r("em",[r("code",[t._v("object")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L143",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:143"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Generate a payload and pplies the signature from a keypair")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("method")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1)]),t._v(" "),r("tr",[r("td",[t._v("account")]),t._v(" "),r("td",[r("code",[t._v("KeyringPair")])])]),t._v(" "),r("tr",[r("td",[t._v("__namedParameters")]),t._v(" "),r("td",[r("code",[t._v("object")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeextrinsicsignature"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeextrinsicsignature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeextrinsicsignature","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeExtrinsicSignature")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeExtrinsicSignature")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1),t._v("): "),r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#uint8array"}},[t._v("Uint8Array")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("object")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/279.293915b9.js b/docs/assets/js/279.293915b9.js deleted file mode 100644 index 67f37d890d..0000000000 --- a/docs/assets/js/279.293915b9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[279],{316:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": Gas")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": A gas number type for Substrate, extending "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ Gas")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new Gas")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[e._v("Gas")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U64.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[e._v("Gas")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/28.83f8aa65.js b/docs/assets/js/28.83f8aa65.js deleted file mode 100644 index 0359c35e16..0000000000 --- a/docs/assets/js/28.83f8aa65.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{363:function(t,a,n){"use strict";n.r(a);var s=n(46),e=Object(s.a)({},function(){var t=this,a=t.$createElement,n=t._self._c||a;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"getheader"}})]),t._v(" "),n("h2",{attrs:{id:"getheader"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#getheader","aria-hidden":"true"}},[t._v("#")]),t._v(" getHeader")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("getHeader")]),t._v("(api: "),n("em",[n("code",[t._v("ApiInterface$Rx")])]),t._v("): "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/getHeader.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("chain/getHeader.ts:25"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("em",[n("strong",[t._v("description")])]),t._v(": Get the a specific block header and extend it with the author")]),t._v(" "),n("p",[n("em",[n("strong",[t._v("example")])]),t._v(":")]),t._v(" "),n("div",{staticClass:"language-javascript line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-javascript"}},[n("code",[n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" author"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" blockNumber "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("getHeader")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x123...456'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nconsole"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`block #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" was authored by ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("author"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br")])]),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("api")]),t._v(" "),n("td",[n("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("hr")])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/280.7f0bf3fd.js b/docs/assets/js/280.7f0bf3fd.js deleted file mode 100644 index a1843f472e..0000000000 --- a/docs/assets/js/280.7f0bf3fd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[280],{404:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Hash")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The default hash that is used accross the system. It is basically just a thin wrapper around "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")]),e._v(", representing a 32-byte blake2b (Substrate) value")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Hash")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[e._v("Finalised")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[e._v("Usurped")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[e._v("ChangesTrieRoot")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[e._v("CodeHash")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[e._v("SeedOf")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Hash")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H256.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/281.e4381f47.js b/docs/assets/js/281.e4381f47.js deleted file mode 100644 index 146fc01261..0000000000 --- a/docs/assets/js/281.e4381f47.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[281],{565:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Header")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")]),t._v(" header")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Header")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[t._v("HeaderExtended")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Header")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_type_header_.html#headervalue"}},[t._v("HeaderValue")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_type_header_.html#headervalue"}},[t._v("HeaderValue")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("null")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"blocknumber"}})]),t._v(" "),r("h2",{attrs:{id:"blocknumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#blocknumber","aria-hidden":"true"}},[t._v("#")]),t._v(" blockNumber")]),t._v(" "),r("p",[r("strong",[t._v("get blockNumber")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"digest"}})]),t._v(" "),r("h2",{attrs:{id:"digest"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#digest","aria-hidden":"true"}},[t._v("#")]),t._v(" digest")]),t._v(" "),r("p",[r("strong",[t._v("get digest")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"extrinsicsroot"}})]),t._v(" "),r("h2",{attrs:{id:"extrinsicsroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extrinsicsroot","aria-hidden":"true"}},[t._v("#")]),t._v(" extrinsicsRoot")]),t._v(" "),r("p",[r("strong",[t._v("get extrinsicsRoot")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:58"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped extrisics root as a "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),t._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),r("p",[r("strong",[t._v("get hash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:65"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Convenience method, encodes the header and calculates the "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"parenthash"}})]),t._v(" "),r("h2",{attrs:{id:"parenthash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#parenthash","aria-hidden":"true"}},[t._v("#")]),t._v(" parentHash")]),t._v(" "),r("p",[r("strong",[t._v("get parentHash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped parent as a "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"stateroot"}})]),t._v(" "),r("h2",{attrs:{id:"stateroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stateroot","aria-hidden":"true"}},[t._v("#")]),t._v(" stateRoot")]),t._v(" "),r("p",[r("strong",[t._v("get stateRoot")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:81"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped state root as a "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/282.607fde22.js b/docs/assets/js/282.607fde22.js deleted file mode 100644 index 38af0b55cd..0000000000 --- a/docs/assets/js/282.607fde22.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[282],{562:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": HeaderExtended")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A "),r("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")]),t._v(" header with an additional "),r("code",[t._v("author")]),t._v(" field that indicates the block author")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ HeaderExtended")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new HeaderExtended")]),t._v("(header?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v(" | "),r("code",[t._v("null")])],1),t._v(", sessionValidators?: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(">")],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[t._v("HeaderExtended")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L92",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:92"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" header")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v(" | "),r("code",[t._v("null")])],1),t._v(" "),r("td",[t._v("null")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" sessionValidators")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(">")],1),t._v(" "),r("td",[t._v("[]")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[t._v("HeaderExtended")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"author"}})]),t._v(" "),r("h2",{attrs:{id:"author"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#author","aria-hidden":"true"}},[t._v("#")]),t._v(" author")]),t._v(" "),r("p",[r("strong",[t._v("get author")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L107",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:107"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Convenience method, returns the author for the block")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"blocknumber"}})]),t._v(" "),r("h2",{attrs:{id:"blocknumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#blocknumber","aria-hidden":"true"}},[t._v("#")]),t._v(" blockNumber")]),t._v(" "),r("p",[r("strong",[t._v("get blockNumber")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html#blocknumber"}},[t._v("blockNumber")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"digest"}})]),t._v(" "),r("h2",{attrs:{id:"digest"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#digest","aria-hidden":"true"}},[t._v("#")]),t._v(" digest")]),t._v(" "),r("p",[r("strong",[t._v("get digest")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html#digest"}},[t._v("digest")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"extrinsicsroot"}})]),t._v(" "),r("h2",{attrs:{id:"extrinsicsroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#extrinsicsroot","aria-hidden":"true"}},[t._v("#")]),t._v(" extrinsicsRoot")]),t._v(" "),r("p",[r("strong",[t._v("get extrinsicsRoot")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html#extrinsicsroot"}},[t._v("extrinsicsRoot")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:58"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped extrisics root as a "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),t._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),r("p",[r("strong",[t._v("get hash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html#hash"}},[t._v("hash")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:65"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Convenience method, encodes the header and calculates the "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"parenthash"}})]),t._v(" "),r("h2",{attrs:{id:"parenthash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#parenthash","aria-hidden":"true"}},[t._v("#")]),t._v(" parentHash")]),t._v(" "),r("p",[r("strong",[t._v("get parentHash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html#parenthash"}},[t._v("parentHash")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped parent as a "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"stateroot"}})]),t._v(" "),r("h2",{attrs:{id:"stateroot"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stateroot","aria-hidden":"true"}},[t._v("#")]),t._v(" stateRoot")]),t._v(" "),r("p",[r("strong",[t._v("get stateRoot")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_header_.header.html#stateroot"}},[t._v("stateRoot")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:81"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The wrapped state root as a "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Header.ts:114"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Creates the JSON representation")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/283.ac798380.js b/docs/assets/js/283.ac798380.js deleted file mode 100644 index 798e1119e5..0000000000 --- a/docs/assets/js/283.ac798380.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[283],{315:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": InherentOfflineReport")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Describes the offline-reporting extrinsic")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ InherentOfflineReport")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new InherentOfflineReport")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v(", value: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[e._v("InherentOfflineReport")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[e._v("InherentOfflineReport")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/284.007fd642.js b/docs/assets/js/284.007fd642.js deleted file mode 100644 index 38d607ba91..0000000000 --- a/docs/assets/js/284.007fd642.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[284],{401:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Justification")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A generic justification as a stream of "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v(", this is specific per consensus implementation")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Justification")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Justification")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[e._v("Justification")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:18"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[e._v("Justification")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:61"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[e._v("Bytes")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/Bytes.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/285.b84294e3.js b/docs/assets/js/285.b84294e3.js deleted file mode 100644 index 9c2351a26a..0000000000 --- a/docs/assets/js/285.b84294e3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[285],{559:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": RhdJustification")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")]),t._v(" for the Rhododendron consensus algorithm")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ RhdJustification")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new RhdJustification")]),t._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_type_justification_.html#rhdjustificationvalue"}},[t._v("RhdJustificationValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("RhdJustification")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Justification.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_type_justification_.html#rhdjustificationvalue"}},[t._v("RhdJustificationValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("RhdJustification")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),t._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),r("p",[r("strong",[t._v("get hash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Justification.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The justification "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"roundnumber"}})]),t._v(" "),r("h2",{attrs:{id:"roundnumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#roundnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" roundNumber")]),t._v(" "),r("p",[r("strong",[t._v("get roundNumber")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Justification.ts:54"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The round this justification wraps as a "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signatures"}})]),t._v(" "),r("h2",{attrs:{id:"signatures"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signatures","aria-hidden":"true"}},[t._v("#")]),t._v(" signatures")]),t._v(" "),r("p",[r("strong",[t._v("get signatures")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("BftAuthoritySignature")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L61",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Justification.ts:61"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("BftAuthoritySignature")]),t._v(" array")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("BftAuthoritySignature")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/286.c64351b3.js b/docs/assets/js/286.c64351b3.js deleted file mode 100644 index f4b401a5ae..0000000000 --- a/docs/assets/js/286.c64351b3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[286],{556:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": KeyValue")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": KeyValue structure. Since most of the keys and resultant values in Subtrate is hashed and/or encoded, this does not wrap "),r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(", but rather a "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")]),t._v(" for the keys and values. (Not to be confused with the KeyValue in "),r("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")]),t._v(", that is actually for Maps, whereas this is a representation of actaul storage values)")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ KeyValue")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new KeyValue")]),t._v("(value?: "),r("em",[r("code",[t._v("KeyValueValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("KeyValue")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/KeyValue.ts:26"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("KeyValueValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("KeyValue")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"key"}})]),t._v(" "),r("h2",{attrs:{id:"key"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[t._v("#")]),t._v(" key")]),t._v(" "),r("p",[r("strong",[t._v("get key")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("StorageKey")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/KeyValue.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("StorageKey")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("StorageKey")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),t._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[t._v("#")]),t._v(" value")]),t._v(" "),r("p",[r("strong",[t._v("get value")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("StorageData")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/KeyValue.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("StorageData")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("StorageData")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/287.d27f6e11.js b/docs/assets/js/287.d27f6e11.js deleted file mode 100644 index 0dd13b252f..0000000000 --- a/docs/assets/js/287.d27f6e11.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[287],{314:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": KeyValueOption")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": A key/value change. This is similar to the "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[e._v("KeyValue")]),e._v(" structure, however in this case the value could be optional. Here it extends from a "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(", indicating the use inside areas such as "),r("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[e._v("StorageChangeSet")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ KeyValueOption")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new KeyValueOption")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_type_keyvalue_.html#keyvalueoptionvalue"}},[e._v("KeyValueOptionValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[e._v("KeyValueOption")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/KeyValue.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_type_keyvalue_.html#keyvalueoptionvalue"}},[e._v("KeyValueOptionValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[e._v("KeyValueOption")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"key"}})]),e._v(" "),r("h2",{attrs:{id:"key"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[e._v("#")]),e._v(" key")]),e._v(" "),r("p",[r("strong",[e._v("get key")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/KeyValue.ts:69"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[e._v("StorageKey")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[e._v("Option")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[e._v("StorageData")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/KeyValue.ts:76"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[e._v("Option")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[e._v("StorageData")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[e._v("Option")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[e._v("StorageData")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/288.ac370bde.js b/docs/assets/js/288.ac370bde.js deleted file mode 100644 index bc774b89cd..0000000000 --- a/docs/assets/js/288.ac370bde.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[288],{313:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": LocKPeriods")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": A number of lock periods.")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[e._v("I8")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ LocKPeriods")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new LocKPeriods")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_lockperiods_.lockperiods.html"}},[e._v("LocKPeriods")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[e._v("I8")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I8.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/I8.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_lockperiods_.lockperiods.html"}},[e._v("LocKPeriods")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/289.e7d1422e.js b/docs/assets/js/289.e7d1422e.js deleted file mode 100644 index d6db89a105..0000000000 --- a/docs/assets/js/289.e7d1422e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[289],{553:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": BftAtReport")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A report of a/b hash-signature pairs for a specific index. This is the same structure as is used in BftDoublePrepare & BftDoubleCommit")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ BftAtReport")])]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[t._v("BftDoublePropose")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[t._v("BftDoublePrepare")])],1),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[t._v("BftDoubleCommit")])],1),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new BftAtReport")]),t._v("(value?: "),r("em",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"a"}})]),t._v(" "),r("h2",{attrs:{id:"a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#a","aria-hidden":"true"}},[t._v("#")]),t._v(" a")]),t._v(" "),r("p",[r("strong",[t._v("get a")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The first report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"b"}})]),t._v(" "),r("h2",{attrs:{id:"b"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#b","aria-hidden":"true"}},[t._v("#")]),t._v(" b")]),t._v(" "),r("p",[r("strong",[t._v("get b")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The second report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"round"}})]),t._v(" "),r("h2",{attrs:{id:"round"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#round","aria-hidden":"true"}},[t._v("#")]),t._v(" round")]),t._v(" "),r("p",[r("strong",[t._v("get round")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The round this report applies to as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/29.47b5be8d.js b/docs/assets/js/29.47b5be8d.js deleted file mode 100644 index 829e93aea4..0000000000 --- a/docs/assets/js/29.47b5be8d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{364:function(t,a,s){"use strict";s.r(a);var e=s(46),n=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"type-aliases"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),s("p",[s("a",{attrs:{id:"headerandvalidators"}})]),t._v(" "),s("h2",{attrs:{id:"headerandvalidators"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#headerandvalidators","aria-hidden":"true"}},[t._v("#")]),t._v(" HeaderAndValidators")]),t._v(" "),s("p",[s("strong",[t._v("Ƭ HeaderAndValidators")]),t._v(": "),s("em",[t._v("["),s("code",[t._v("Header")]),t._v(", "),s("code",[t._v("Array")]),t._v("<"),s("code",[t._v("AccountId")]),t._v(">]")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/subscribeNewHead.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("chain/subscribeNewHead.ts:12"),s("OutboundLink")],1)])]),t._v(" "),s("hr"),t._v(" "),s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"subscribenewhead"}})]),t._v(" "),s("h2",{attrs:{id:"subscribenewhead"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#subscribenewhead","aria-hidden":"true"}},[t._v("#")]),t._v(" subscribeNewHead")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("subscribeNewHead")]),t._v("(api: "),s("em",[s("code",[t._v("ApiInterface$Rx")])]),t._v("): "),s("code",[t._v("(Anonymous function)")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/chain/subscribeNewHead.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("chain/subscribeNewHead.ts:25"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Subscribe to block headers and extend it with the author")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("example")])]),t._v(":")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[t._v("api"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" author"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" blockNumber "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`block #")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockNumber"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" was authored by ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("author"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br")])]),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("api")]),t._v(" "),s("td",[s("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("(Anonymous function)")])]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/290.0a031606.js b/docs/assets/js/290.0a031606.js deleted file mode 100644 index 62f25011ad..0000000000 --- a/docs/assets/js/290.0a031606.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[290],{550:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": BftDoubleCommit")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Report of a double-commit")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ BftDoubleCommit")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new BftDoubleCommit")]),t._v("(value?: "),r("em",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[t._v("BftDoubleCommit")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[t._v("BftDoubleCommit")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"a"}})]),t._v(" "),r("h2",{attrs:{id:"a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#a","aria-hidden":"true"}},[t._v("#")]),t._v(" a")]),t._v(" "),r("p",[r("strong",[t._v("get a")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#a"}},[t._v("a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The first report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"b"}})]),t._v(" "),r("h2",{attrs:{id:"b"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#b","aria-hidden":"true"}},[t._v("#")]),t._v(" b")]),t._v(" "),r("p",[r("strong",[t._v("get b")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#b"}},[t._v("b")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The second report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"round"}})]),t._v(" "),r("h2",{attrs:{id:"round"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#round","aria-hidden":"true"}},[t._v("#")]),t._v(" round")]),t._v(" "),r("p",[r("strong",[t._v("get round")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#round"}},[t._v("round")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The round this report applies to as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/291.8de8ff06.js b/docs/assets/js/291.8de8ff06.js deleted file mode 100644 index 83ece8be8f..0000000000 --- a/docs/assets/js/291.8de8ff06.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[291],{547:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": BftDoublePrepare")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Report of a double-prepare")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ BftDoublePrepare")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new BftDoublePrepare")]),t._v("(value?: "),r("em",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[t._v("BftDoublePrepare")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[t._v("BftDoublePrepare")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"a"}})]),t._v(" "),r("h2",{attrs:{id:"a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#a","aria-hidden":"true"}},[t._v("#")]),t._v(" a")]),t._v(" "),r("p",[r("strong",[t._v("get a")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#a"}},[t._v("a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The first report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"b"}})]),t._v(" "),r("h2",{attrs:{id:"b"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#b","aria-hidden":"true"}},[t._v("#")]),t._v(" b")]),t._v(" "),r("p",[r("strong",[t._v("get b")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#b"}},[t._v("b")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The second report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"round"}})]),t._v(" "),r("h2",{attrs:{id:"round"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#round","aria-hidden":"true"}},[t._v("#")]),t._v(" round")]),t._v(" "),r("p",[r("strong",[t._v("get round")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#round"}},[t._v("round")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The round this report applies to as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/292.bb0ea38c.js b/docs/assets/js/292.bb0ea38c.js deleted file mode 100644 index d35bec985b..0000000000 --- a/docs/assets/js/292.bb0ea38c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[292],{544:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": BftDoublePropose")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Report of a double-propose")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ BftDoublePropose")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new BftDoublePropose")]),t._v("(value?: "),r("em",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[t._v("BftDoublePropose")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[t._v("BftDoublePropose")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"a"}})]),t._v(" "),r("h2",{attrs:{id:"a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#a","aria-hidden":"true"}},[t._v("#")]),t._v(" a")]),t._v(" "),r("p",[r("strong",[t._v("get a")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#a"}},[t._v("a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The first report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"b"}})]),t._v(" "),r("h2",{attrs:{id:"b"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#b","aria-hidden":"true"}},[t._v("#")]),t._v(" b")]),t._v(" "),r("p",[r("strong",[t._v("get b")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#b"}},[t._v("b")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The second report "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"round"}})]),t._v(" "),r("h2",{attrs:{id:"round"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#round","aria-hidden":"true"}},[t._v("#")]),t._v(" round")]),t._v(" "),r("p",[r("strong",[t._v("get round")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html#round"}},[t._v("round")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:59"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The round this report applies to as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/293.52eda1cd.js b/docs/assets/js/293.52eda1cd.js deleted file mode 100644 index 9f479ead62..0000000000 --- a/docs/assets/js/293.52eda1cd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[293],{541:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": BftProposeOutOfTurn")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A report for out-of-turn proposals")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ BftProposeOutOfTurn")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new BftProposeOutOfTurn")]),t._v("(value?: "),r("em",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("BftProposeOutOfTurn")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L69",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:69"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("BftAtReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("BftProposeOutOfTurn")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"a"}})]),t._v(" "),r("h2",{attrs:{id:"a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#a","aria-hidden":"true"}},[t._v("#")]),t._v(" a")]),t._v(" "),r("p",[r("strong",[t._v("get a")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:80"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")]),t._v(" the report applies to")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"round"}})]),t._v(" "),r("h2",{attrs:{id:"round"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#round","aria-hidden":"true"}},[t._v("#")]),t._v(" round")]),t._v(" "),r("p",[r("strong",[t._v("get round")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:87"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The round as [[u32]]")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/294.2cacd6cf.js b/docs/assets/js/294.2cacd6cf.js deleted file mode 100644 index a204f66036..0000000000 --- a/docs/assets/js/294.2cacd6cf.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[294],{535:function(e,t,r){"use strict";r.r(t);var s=r(46),o=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": MisbehaviorKind")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v(" containing a Bft misbehaviour")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[e._v("BftProposeOutOfTurn")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[e._v("BftDoublePropose")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[e._v("BftDoublePrepare")]),e._v(" | "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[e._v("BftDoubleCommit")]),e._v(">")],1),e._v(" "),r("p",[r("strong",[e._v("↳ MisbehaviorKind")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new MisbehaviorKind")]),e._v("(value?: "),r("em",[r("code",[e._v("BftAtReportValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v(", index?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[e._v("MisbehaviorKind")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/MisbehaviorReport.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("BftAtReportValue")]),e._v(" | "),r("code",[e._v("Uint8Array")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[e._v("MisbehaviorKind")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"asbftdoublecommit"}})]),e._v(" "),r("h2",{attrs:{id:"asbftdoublecommit"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asbftdoublecommit","aria-hidden":"true"}},[e._v("#")]),e._v(" asBftDoubleCommit")]),e._v(" "),r("p",[r("strong",[e._v("get asBftDoubleCommit")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[e._v("BftDoubleCommit")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L134",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/MisbehaviorReport.ts:134"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[e._v("BftDoubleCommit")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[e._v("BftDoubleCommit")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"asbftdoubleprepare"}})]),e._v(" "),r("h2",{attrs:{id:"asbftdoubleprepare"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asbftdoubleprepare","aria-hidden":"true"}},[e._v("#")]),e._v(" asBftDoublePrepare")]),e._v(" "),r("p",[r("strong",[e._v("get asBftDoublePrepare")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[e._v("BftDoublePrepare")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/MisbehaviorReport.ts:141"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[e._v("BftDoublePrepare")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[e._v("BftDoublePrepare")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"asbftdoublepropose"}})]),e._v(" "),r("h2",{attrs:{id:"asbftdoublepropose"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asbftdoublepropose","aria-hidden":"true"}},[e._v("#")]),e._v(" asBftDoublePropose")]),e._v(" "),r("p",[r("strong",[e._v("get asBftDoublePropose")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[e._v("BftDoublePropose")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/MisbehaviorReport.ts:148"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[e._v("BftDoublePropose")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[e._v("BftDoublePropose")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"asbftproposeoutofturn"}})]),e._v(" "),r("h2",{attrs:{id:"asbftproposeoutofturn"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#asbftproposeoutofturn","aria-hidden":"true"}},[e._v("#")]),e._v(" asBftProposeOutOfTurn")]),e._v(" "),r("p",[r("strong",[e._v("get asBftProposeOutOfTurn")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[e._v("BftProposeOutOfTurn")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/MisbehaviorReport.ts:155"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the item as a "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[e._v("BftProposeOutOfTurn")])],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[e._v("BftProposeOutOfTurn")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#index"}},[e._v("index")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The index of the metadata value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:128"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnone"}})]),e._v(" "),r("h2",{attrs:{id:"isnone"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnone","aria-hidden":"true"}},[e._v("#")]),e._v(" isNone")]),e._v(" "),r("p",[r("strong",[e._v("get isNone")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnone"}},[e._v("isNone")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:135"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isnull"}})]),e._v(" "),r("h2",{attrs:{id:"isnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isnull","aria-hidden":"true"}},[e._v("#")]),e._v(" isNull")]),e._v(" "),r("p",[r("strong",[e._v("get isNull")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#isnull"}},[e._v("isNull")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:142"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the Enum points to a "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[e._v("Null")]),e._v(" type (deprecated, use isNone)")],1),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),e._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[e._v("#")]),e._v(" type")]),e._v(" "),r("p",[r("strong",[e._v("get type")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#type"}},[e._v("type")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The name of the type this enum value represents")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"value"}})]),e._v(" "),r("h2",{attrs:{id:"value"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#value","aria-hidden":"true"}},[e._v("#")]),e._v(" value")]),e._v(" "),r("p",[r("strong",[e._v("get value")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#value"}},[e._v("value")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:156"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The value of the enum")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:163"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:176"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:183"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:192"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:199"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:209"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("<"),r("code",[e._v("S")]),e._v(">(Types: "),r("em",[r("code",[e._v("S")])]),e._v("): "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/EnumType.ts:101"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[e._v("ConstructorDef")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("S")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("EnumConstructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[e._v("EnumType")]),e._v("<"),r("code",[e._v("S")]),e._v(">>")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/295.7fe48d44.js b/docs/assets/js/295.7fe48d44.js deleted file mode 100644 index c019076a76..0000000000 --- a/docs/assets/js/295.7fe48d44.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[295],{538:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": MisbehaviorReport")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A Misbehaviour report of [[MisbehavioirKind]] against a specific "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("AuthorityId")])],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ MisbehaviorReport")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new MisbehaviorReport")]),t._v("(value?: "),r("em",[r("code",[t._v("MisbehaviorReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L172",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:172"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("MisbehaviorReportValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"misbehavior"}})]),t._v(" "),r("h2",{attrs:{id:"misbehavior"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#misbehavior","aria-hidden":"true"}},[t._v("#")]),t._v(" misbehavior")]),t._v(" "),r("p",[r("strong",[t._v("get misbehavior")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[t._v("MisbehaviorKind")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L185",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:185"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[t._v("MisbehaviorKind")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[t._v("MisbehaviorKind")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"parenthash"}})]),t._v(" "),r("h2",{attrs:{id:"parenthash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#parenthash","aria-hidden":"true"}},[t._v("#")]),t._v(" parentHash")]),t._v(" "),r("p",[r("strong",[t._v("get parentHash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:192"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")]),t._v(" of the parent block")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"parentnumber"}})]),t._v(" "),r("h2",{attrs:{id:"parentnumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#parentnumber","aria-hidden":"true"}},[t._v("#")]),t._v(" parentNumber")]),t._v(" "),r("p",[r("strong",[t._v("get parentNumber")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L199",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:199"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")]),t._v(" of the parent")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"target"}})]),t._v(" "),r("h2",{attrs:{id:"target"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#target","aria-hidden":"true"}},[t._v("#")]),t._v(" target")]),t._v(" "),r("p",[r("strong",[t._v("get target")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("AuthorityId")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L206",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/MisbehaviorReport.ts:206"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html#authorityid"}},[t._v("authorityId")]),t._v(" the report applies to")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("AuthorityId")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/296.f61c2c00.js b/docs/assets/js/296.f61c2c00.js deleted file mode 100644 index 8a15edb82f..0000000000 --- a/docs/assets/js/296.f61c2c00.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[296],{564:function(e,t,r){"use strict";r.r(t);var o=r(46),_=Object(o.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": NewAccountOutcome")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Enum to track the outcome for creation of an "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ NewAccountOutcome")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NewAccountOutcome")]),e._v("(index?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("number")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[e._v("NewAccountOutcome")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/NewAccountOutcome.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/NewAccountOutcome.ts:13"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("number")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[e._v("NewAccountOutcome")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:64"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:71"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value (always false)")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:78"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:112"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:120"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeenum"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodeenum"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeenum","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeEnum")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeEnum")]),e._v("(def: "),r("em",[r("code",[e._v("EnumDef")])]),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#decodeenum"}},[e._v("decodeEnum")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:47"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("def")]),e._v(" "),r("td",[r("code",[e._v("EnumDef")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/297.c1127367.js b/docs/assets/js/297.c1127367.js deleted file mode 100644 index edd5373db7..0000000000 --- a/docs/assets/js/297.c1127367.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[297],{311:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": Nonce")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The Nonce or number of transactions sent by a specific account. Generally used with extrinsics to determine the order of execution. implemented as a Substrate "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ Nonce")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new Nonce")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[e._v("Nonce")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U64.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[e._v("Nonce")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/298.b924b2b9.js b/docs/assets/js/298.b924b2b9.js deleted file mode 100644 index 0f7d778f61..0000000000 --- a/docs/assets/js/298.b924b2b9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[298],{532:function(t,e,r){"use strict";r.r(e);var o=r(46),a=Object(o.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Nonce")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The Compact or number of transactions sent by a specific account. Generally used with extrinsics to determine the order of execution.")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ NonceCompact")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new NonceCompact")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v(", value?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_noncecompact_.noncecompact.html"}},[t._v("NonceCompact")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(" "),r("td",[t._v("0")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_noncecompact_.noncecompact.html"}},[t._v("NonceCompact")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"addlengthprefix"}})]),t._v(" "),r("h2",{attrs:{id:"static-addlengthprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-addlengthprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" addLengthPrefix")]),t._v(" "),r("p",[r("strong",[t._v("● addLengthPrefix")]),t._v(": "),r("em",[r("code",[t._v("compactAddLength")])]),t._v(" = compactAddLength")]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#addlengthprefix"}},[t._v("addLengthPrefix")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:41"),r("OutboundLink")],1)])]),t._v(" "),r("p",[t._v("Prepend a Uint8Array with its compact length.")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("param")])]),t._v(": The Uint8Array to be prefixed")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeU8a")]),t._v(" "),r("p",[r("strong",[t._v("● decodeU8a")]),t._v(": "),r("em",[r("code",[t._v("compactFromU8a")])]),t._v(" = compactFromU8a")]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#decodeu8a"}},[t._v("decodeU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:42"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"static-encodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-encodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" encodeU8a")]),t._v(" "),r("p",[r("strong",[t._v("● encodeU8a")]),t._v(": "),r("em",[r("code",[t._v("compactToU8a")])]),t._v(" = compactToU8a")]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#encodeu8a"}},[t._v("encodeU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:43"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:72"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:79"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),t._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" bitLength")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("bitLength")]),t._v("(): "),r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#bitlength"}},[t._v("bitLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:86"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the number of bits in the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:93"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tobn"}})]),t._v(" "),r("h2",{attrs:{id:"tobn"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[t._v("#")]),t._v(" toBn")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toBn")]),t._v("(): "),r("code",[t._v("BN")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#tobn"}},[t._v("toBn")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L104",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:104"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the BN representation of the number")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("BN")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L111",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:111"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L118",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:118"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),t._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[t._v("#")]),t._v(" toNumber")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toNumber")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#tonumber"}},[t._v("toNumber")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the number representation for the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:132"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:140"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"unwrap"}})]),t._v(" "),r("h2",{attrs:{id:"unwrap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unwrap","aria-hidden":"true"}},[t._v("#")]),t._v(" unwrap")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("unwrap")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#unwrap"}},[t._v("unwrap")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L147",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:147"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the embedded "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" or "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" value")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodecompact"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodecompact"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodecompact","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeCompact")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeCompact")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#decodecompact"}},[t._v("decodeCompact")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1)]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"striplengthprefix"}})]),t._v(" "),r("h2",{attrs:{id:"static-striplengthprefix"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-striplengthprefix","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" stripLengthPrefix")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("stripLengthPrefix")]),t._v("(u8a: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", bitLength?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#striplengthprefix"}},[t._v("stripLengthPrefix")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Default value")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("u8a")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])]),t._v(" "),r("td",[t._v("-")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Default value")]),t._v(" bitLength")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[t._v("UIntBitLength")])],1),t._v(" "),r("td",[t._v("DEFAULT_BITLENGTH")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("(Type: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Compact.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")]),t._v(" | "),r("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")]),t._v(">")],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(">")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/299.932c15ac.js b/docs/assets/js/299.932c15ac.js deleted file mode 100644 index 15bd3b3857..0000000000 --- a/docs/assets/js/299.932c15ac.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[299],{566:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Origin")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Where Origin occurs, it should be ignored as an internal-only value, so it should never actually be constructed")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Origin")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Origin")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("Origin")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Origin.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Origin.ts:13"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("Origin")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value (always true)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:31"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:38"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Null.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/3.04cf2d04.js b/docs/assets/js/3.04cf2d04.js deleted file mode 100644 index 4fb14dda1e..0000000000 --- a/docs/assets/js/3.04cf2d04.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[3],{264:function(t,e,n){},299:function(t,e,n){"use strict";var a=n(264);n.n(a).a},527:function(t,e,n){"use strict";n.r(e);var a={functional:!0,props:{type:{type:String,default:"tip"},text:String,vertical:{type:String,default:"top"}},render:function(t,e){var n=e.props,a=e.slots;return t("span",{class:["badge",n.type,n.vertical]},n.text||a().default)}},r=(n(299),n(46)),i=Object(r.a)(a,void 0,void 0,!1,null,"efceadb8",null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/30.a8182388.js b/docs/assets/js/30.a8182388.js deleted file mode 100644 index be77860eea..0000000000 --- a/docs/assets/js/30.a8182388.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{366:function(e,r,t){"use strict";t.r(r);var n=t(46),a=Object(n.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),t("h3",{attrs:{id:"classes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html"}},[e._v("ReferendumInfoExtended")])],1)]),e._v(" "),t("h3",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/api-derive/modules/_democracy_referenduminfo_.html#referenduminfo"}},[e._v("referendumInfo")])],1)]),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"functions-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"referenduminfo"}})]),e._v(" "),t("h2",{attrs:{id:"referenduminfo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#referenduminfo","aria-hidden":"true"}},[e._v("#")]),e._v(" referendumInfo")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("referendumInfo")]),e._v("(api: "),t("em",[t("code",[e._v("ApiInterface$Rx")])]),e._v("): "),t("code",[e._v("(Anonymous function)")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfo.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfo.ts:48"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("api")]),e._v(" "),t("td",[t("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("(Anonymous function)")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/300.d570b029.js b/docs/assets/js/300.d570b029.js deleted file mode 100644 index ce586fcd03..0000000000 --- a/docs/assets/js/300.d570b029.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[300],{310:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": ParaId")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Identifier for a deployed parachain implemented as a "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ ParaId")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new ParaId")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[e._v("ParaId")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[e._v("ParaId")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/301.019d11c7.js b/docs/assets/js/301.019d11c7.js deleted file mode 100644 index 8be8095409..0000000000 --- a/docs/assets/js/301.019d11c7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[301],{309:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": Perbill")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Parts per billion (see also "),v("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[e._v("Permill")]),e._v(")")],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ Perbill")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new Perbill")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[e._v("Perbill")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[e._v("Perbill")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/302.c611b601.js b/docs/assets/js/302.c611b601.js deleted file mode 100644 index c97e1652ec..0000000000 --- a/docs/assets/js/302.c611b601.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[302],{308:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": Permill")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Parts per million (See also "),v("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[e._v("Perbill")]),e._v(")")],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ Permill")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new Permill")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[e._v("Permill")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[e._v("Permill")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/303.a376d327.js b/docs/assets/js/303.a376d327.js deleted file mode 100644 index e4f1c298e6..0000000000 --- a/docs/assets/js/303.a376d327.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[303],{302:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": PrefabWasmModule")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Struct to encode the vesting schedule of an individual account")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ PrefabWasmModule")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new PrefabWasmModule")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("PrefabWasmModule")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/PrefabWasmModule.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("PrefabWasmModule")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"code"}})]),t._v(" "),r("h2",{attrs:{id:"code"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#code","aria-hidden":"true"}},[t._v("#")]),t._v(" code")]),t._v(" "),r("p",[r("strong",[t._v("get code")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/PrefabWasmModule.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The code as "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"initial"}})]),t._v(" "),r("h2",{attrs:{id:"initial"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#initial","aria-hidden":"true"}},[t._v("#")]),t._v(" initial")]),t._v(" "),r("p",[r("strong",[t._v("get initial")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/PrefabWasmModule.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The initial as "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maximum"}})]),t._v(" "),r("h2",{attrs:{id:"maximum"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maximum","aria-hidden":"true"}},[t._v("#")]),t._v(" maximum")]),t._v(" "),r("p",[r("strong",[t._v("get maximum")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/PrefabWasmModule.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The maximum as "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"scheduleversion"}})]),t._v(" "),r("h2",{attrs:{id:"scheduleversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#scheduleversion","aria-hidden":"true"}},[t._v("#")]),t._v(" scheduleVersion")]),t._v(" "),r("p",[r("strong",[t._v("get scheduleVersion")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/PrefabWasmModule.ts:54"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The scheduleVersion value as "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/304.5f0cff90.js b/docs/assets/js/304.5f0cff90.js deleted file mode 100644 index 63aeff96e7..0000000000 --- a/docs/assets/js/304.5f0cff90.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[304],{307:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": PropIndex")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An increasing number that represents a specific public proposal index in the system, implemented as a "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ PropIndex")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new PropIndex")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[e._v("PropIndex")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[e._v("PropIndex")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/305.63e74ee3.js b/docs/assets/js/305.63e74ee3.js deleted file mode 100644 index dcc6c21474..0000000000 --- a/docs/assets/js/305.63e74ee3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[305],{526:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Proposal")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A proposal in the system. It just extends "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v(" (Proposal = Call in Rust)")],1),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Proposal")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Proposal")]),t._v("(value: "),r("em",[r("code",[t._v("any")])]),t._v(", meta?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L70",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:70"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("any")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" meta")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"args"}})]),t._v(" "),r("h2",{attrs:{id:"args"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#args","aria-hidden":"true"}},[t._v("#")]),t._v(" args")]),t._v(" "),r("p",[r("strong",[t._v("get args")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#args"}},[t._v("args")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L192",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:192"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The arguments for the function call")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"argsdef"}})]),t._v(" "),r("h2",{attrs:{id:"argsdef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#argsdef","aria-hidden":"true"}},[t._v("#")]),t._v(" argsDef")]),t._v(" "),r("p",[r("strong",[t._v("get argsDef")]),t._v("(): "),r("code",[t._v("ArgsDef")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#argsdef"}},[t._v("argsDef")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L200",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:200"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Thge argument defintions")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("ArgsDef")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"callindex"}})]),t._v(" "),r("h2",{attrs:{id:"callindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#callindex","aria-hidden":"true"}},[t._v("#")]),t._v(" callIndex")]),t._v(" "),r("p",[r("strong",[t._v("get callIndex")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#callindex"}},[t._v("callIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L207",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:207"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The encoded "),r("code",[t._v("[sectionIndex, methodIndex]")]),t._v(" identifier")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("get data")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#data"}},[t._v("data")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L214",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:214"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The encoded data")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hasorigin"}})]),t._v(" "),r("h2",{attrs:{id:"hasorigin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hasorigin","aria-hidden":"true"}},[t._v("#")]),t._v(" hasOrigin")]),t._v(" "),r("p",[r("strong",[t._v("get hasOrigin")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#hasorigin"}},[t._v("hasOrigin")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L221",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:221"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": "),r("code",[t._v("true")]),t._v(" if the "),r("code",[t._v("Origin")]),t._v(" type is on the method (extrinsic method)")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"meta"}})]),t._v(" "),r("h2",{attrs:{id:"meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),r("p",[r("strong",[t._v("get meta")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#meta"}},[t._v("meta")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L230",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:230"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"filterorigin"}})]),t._v(" "),r("h2",{attrs:{id:"static-filterorigin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-filterorigin","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" filterOrigin")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("filterOrigin")]),t._v("(meta?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#filterorigin"}},[t._v("filterOrigin")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:140"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" meta")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"findfunction"}})]),t._v(" "),r("h2",{attrs:{id:"static-findfunction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-findfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" findFunction")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("findFunction")]),t._v("(callIndex: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methodfunction.html"}},[t._v("MethodFunction")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#findfunction"}},[t._v("findFunction")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:156"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callIndex")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methodfunction.html"}},[t._v("MethodFunction")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"injectmethods"}})]),t._v(" "),r("h2",{attrs:{id:"static-injectmethods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-injectmethods","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" injectMethods")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("injectMethods")]),t._v("(moduleMethods: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.moduleswithmethods.html"}},[t._v("ModulesWithMethods")])],1),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html#injectmethods"}},[t._v("injectMethods")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L181",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:181"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("moduleMethods")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.moduleswithmethods.html"}},[t._v("ModulesWithMethods")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/306.cca22ee6.js b/docs/assets/js/306.cca22ee6.js deleted file mode 100644 index a71d3c0771..0000000000 --- a/docs/assets/js/306.cca22ee6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[306],{305:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": ProposalIndex")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An increasing number that represents a specific council proposal index in the system, implemented as "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ ProposalIndex")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new ProposalIndex")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[e._v("ProposalIndex")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[e._v("ProposalIndex")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/307.c95b53d7.js b/docs/assets/js/307.c95b53d7.js deleted file mode 100644 index 7e8a42572f..0000000000 --- a/docs/assets/js/307.c95b53d7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[307],{306:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": ReferendumIndex")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": An increasing number that represents a specific referendum in the system. It is unique per chain. Implemented as "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ ReferendumIndex")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new ReferendumIndex")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[e._v("ReferendumIndex")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[e._v("ReferendumIndex")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/308.5fda621d.js b/docs/assets/js/308.5fda621d.js deleted file mode 100644 index 23400a2316..0000000000 --- a/docs/assets/js/308.5fda621d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[308],{523:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": ReferendumInfo")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Info regarding an ongoing referendum")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ ReferendumInfo")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new ReferendumInfo")]),t._v("(value?: "),r("em",[r("code",[t._v("ReferendumInfoValue")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("string")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("ReferendumInfo")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ReferendumInfo.ts:24"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("ReferendumInfoValue")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("Map")]),t._v("<"),r("code",[t._v("string")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("ReferendumInfo")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delay"}})]),t._v(" "),r("h2",{attrs:{id:"delay"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delay","aria-hidden":"true"}},[t._v("#")]),t._v(" delay")]),t._v(" "),r("p",[r("strong",[t._v("get delay")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ReferendumInfo.ts:58"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The delay (in blocks) to wait after a successful referendum before deploying")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"end"}})]),t._v(" "),r("h2",{attrs:{id:"end"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#end","aria-hidden":"true"}},[t._v("#")]),t._v(" end")]),t._v(" "),r("p",[r("strong",[t._v("get end")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ReferendumInfo.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": When voting on this referendum will end")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"proposal"}})]),t._v(" "),r("h2",{attrs:{id:"proposal"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#proposal","aria-hidden":"true"}},[t._v("#")]),t._v(" proposal")]),t._v(" "),r("p",[r("strong",[t._v("get proposal")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ReferendumInfo.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The proposal being voted on")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"threshold"}})]),t._v(" "),r("h2",{attrs:{id:"threshold"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#threshold","aria-hidden":"true"}},[t._v("#")]),t._v(" threshold")]),t._v(" "),r("p",[r("strong",[t._v("get threshold")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[t._v("VoteThreshold")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L51",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ReferendumInfo.ts:51"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The thresholding mechanism to determine whether it passed")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[t._v("VoteThreshold")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/309.9b876058.js b/docs/assets/js/309.9b876058.js deleted file mode 100644 index b8aa76b3bb..0000000000 --- a/docs/assets/js/309.9b876058.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[309],{520:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": Schedule")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Definition of the cost schedule and other parameterizations for wasm vm")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ Schedule")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new Schedule")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("Schedule")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("Schedule")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"growmemcost"}})]),t._v(" "),r("h2",{attrs:{id:"growmemcost"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#growmemcost","aria-hidden":"true"}},[t._v("#")]),t._v(" growMemCost")]),t._v(" "),r("p",[r("strong",[t._v("get growMemCost")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:32"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Gas cost of a growing memory by single page.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maxmemorypages"}})]),t._v(" "),r("h2",{attrs:{id:"maxmemorypages"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maxmemorypages","aria-hidden":"true"}},[t._v("#")]),t._v(" maxMemoryPages")]),t._v(" "),r("p",[r("strong",[t._v("get maxMemoryPages")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:39"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": What is the maximal memory pages amount is allowed to have for a contract.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"maxstackheight"}})]),t._v(" "),r("h2",{attrs:{id:"maxstackheight"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#maxstackheight","aria-hidden":"true"}},[t._v("#")]),t._v(" maxStackHeight")]),t._v(" "),r("p",[r("strong",[t._v("get maxStackHeight")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:46"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": How tall the stack is allowed to grow?")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"putcodeperbytecost"}})]),t._v(" "),r("h2",{attrs:{id:"putcodeperbytecost"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#putcodeperbytecost","aria-hidden":"true"}},[t._v("#")]),t._v(" putCodePerByteCost")]),t._v(" "),r("p",[r("strong",[t._v("get putCodePerByteCost")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:53"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Cost of putting a byte of code into the storage.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"regularopcost"}})]),t._v(" "),r("h2",{attrs:{id:"regularopcost"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#regularopcost","aria-hidden":"true"}},[t._v("#")]),t._v(" regularOpCost")]),t._v(" "),r("p",[r("strong",[t._v("get regularOpCost")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:60"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Gas cost of a regular operation.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"returndataperbytecost"}})]),t._v(" "),r("h2",{attrs:{id:"returndataperbytecost"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#returndataperbytecost","aria-hidden":"true"}},[t._v("#")]),t._v(" returnDataPerByteCost")]),t._v(" "),r("p",[r("strong",[t._v("get returnDataPerByteCost")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:67"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Gas cost per one byte returned.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sandboxdatareadcost"}})]),t._v(" "),r("h2",{attrs:{id:"sandboxdatareadcost"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sandboxdatareadcost","aria-hidden":"true"}},[t._v("#")]),t._v(" sandboxDataReadCost")]),t._v(" "),r("p",[r("strong",[t._v("get sandboxDataReadCost")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Gas cost per one byte read from the sandbox memory.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sandboxdatawritecost"}})]),t._v(" "),r("h2",{attrs:{id:"sandboxdatawritecost"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sandboxdatawritecost","aria-hidden":"true"}},[t._v("#")]),t._v(" sandboxDataWriteCost")]),t._v(" "),r("p",[r("strong",[t._v("get sandboxDataWriteCost")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:81"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Gas cost per one byte written to the sandbox memory.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"version"}})]),t._v(" "),r("h2",{attrs:{id:"version"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#version","aria-hidden":"true"}},[t._v("#")]),t._v(" version")]),t._v(" "),r("p",[r("strong",[t._v("get version")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Schedule.ts:88"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Version of the schedule.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/31.f46c7404.js b/docs/assets/js/31.f46c7404.js deleted file mode 100644 index 7a6f0eaa36..0000000000 --- a/docs/assets/js/31.f46c7404.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{367:function(e,t,r){"use strict";r.r(t);var n=r(46),a=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"referenduminfos"}})]),e._v(" "),r("h2",{attrs:{id:"referenduminfos"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#referenduminfos","aria-hidden":"true"}},[e._v("#")]),e._v(" referendumInfos")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("referendumInfos")]),e._v("(api: "),r("em",[r("code",[e._v("ApiInterface$Rx")])]),e._v("): "),r("code",[e._v("(Anonymous function)")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumInfos.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumInfos.ts:13"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("api")]),e._v(" "),r("td",[r("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("(Anonymous function)")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/310.419a700f.js b/docs/assets/js/310.419a700f.js deleted file mode 100644 index c47b033469..0000000000 --- a/docs/assets/js/310.419a700f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[310],{398:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": SeedOf")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The Substrate SeedOf representation as a "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")]),e._v(".")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[e._v("Hash")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ SeedOf")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new SeedOf")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[e._v("SeedOf")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[e._v("H256")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H256.ts:15"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[e._v("SeedOf")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/311.f8af589d.js b/docs/assets/js/311.f8af589d.js deleted file mode 100644 index c86e330ae9..0000000000 --- a/docs/assets/js/311.f8af589d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[311],{395:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": SessionKey")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Wrapper for a SessionKey. Same as an normal "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[e._v("AuthorityId")]),e._v(", i.e. a wrapper around publicKey.")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[e._v("AuthorityId")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ SessionKey")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new SessionKey")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[e._v("SessionKey")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Default value")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Default value")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v(" "),r("td",[e._v("new Uint8Array()")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[e._v("SessionKey")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:46"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:53"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:60"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encode"}})]),e._v(" "),r("h2",{attrs:{id:"static-encode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-encode","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" encode")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("encode")]),e._v("(value: "),r("em",[r("code",[e._v("Uint8Array")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[e._v("AccountId")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html#encode"}},[e._v("encode")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/AccountId.ts:27"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/312.2450b227.js b/docs/assets/js/312.2450b227.js deleted file mode 100644 index 3e8a8f04b2..0000000000 --- a/docs/assets/js/312.2450b227.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[312],{392:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Ed25519Signature")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The default Ed25519 that is used accross the system. It is currectly defined as a 512-bit value, represented by a "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v(".")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Ed25519Signature")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Ed25519Signature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.ed25519signature.html"}},[e._v("Ed25519Signature")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H512.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.ed25519signature.html"}},[e._v("Ed25519Signature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/313.b9009865.js b/docs/assets/js/313.b9009865.js deleted file mode 100644 index 2f4b676f6e..0000000000 --- a/docs/assets/js/313.b9009865.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[313],{389:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Signature")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The default signature that is used accross the system. It is currectly defined as a 512-bit value, represented by a "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v(".")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Signature")])]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.ed25519signature.html"}},[e._v("Ed25519Signature")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.sr25519signature.html"}},[e._v("Sr25519Signature")])],1),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[e._v("CandidateSignature")])],1),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Signature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H512.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/314.53a72f42.js b/docs/assets/js/314.53a72f42.js deleted file mode 100644 index 0854df0262..0000000000 --- a/docs/assets/js/314.53a72f42.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[314],{386:function(e,t,r){"use strict";r.r(t);var a=r(46),_=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": Sr25519Signature")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The default Sr25519 signature that is used accross the system. It is currectly defined as a 512-bit value, represented by a "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v(".")],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[e._v("Signature")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ Sr25519Signature")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("number")]),e._v("]: "),r("code",[e._v("number")])]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new Sr25519Signature")]),e._v("(value?: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.sr25519signature.html"}},[e._v("Sr25519Signature")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[e._v("H512")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/H512.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signature_.sr25519signature.html"}},[e._v("Sr25519Signature")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"bytes_per_element"}})]),e._v(" "),r("h2",{attrs:{id:"bytes-per-element"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytes-per-element","aria-hidden":"true"}},[e._v("#")]),e._v(" BYTES_PER_ELEMENT")]),e._v(" "),r("p",[r("strong",[e._v("● BYTES_PER_ELEMENT")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.BYTES_PER_ELEMENT")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962")])]),e._v(" "),r("p",[e._v("The size in bytes of each element in the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),e._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[e._v("#")]),e._v(" __@toStringTag")]),e._v(" "),r("p",[r("strong",[e._v("● __@toStringTag")]),e._v(": "),r("em",[e._v('"UInt8Array"')])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.toStringTag]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"buffer"}})]),e._v(" "),r("h2",{attrs:{id:"buffer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#buffer","aria-hidden":"true"}},[e._v("#")]),e._v(" buffer")]),e._v(" "),r("p",[r("strong",[e._v("● buffer")]),e._v(": "),r("em",[r("code",[e._v("ArrayBufferLike")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.buffer")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967")])]),e._v(" "),r("p",[e._v("The ArrayBuffer instance referenced by the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bytelength"}})]),e._v(" "),r("h2",{attrs:{id:"bytelength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),r("p",[r("strong",[e._v("● byteLength")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteLength")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972")])]),e._v(" "),r("p",[e._v("The length in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"byteoffset"}})]),e._v(" "),r("h2",{attrs:{id:"byteoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#byteoffset","aria-hidden":"true"}},[e._v("#")]),e._v(" byteOffset")]),e._v(" "),r("p",[r("strong",[e._v("● byteOffset")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.byteOffset")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977")])]),e._v(" "),r("p",[e._v("The offset in bytes of the array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:36"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:43"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns true if the type wraps an empty/default all-0 value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("get length")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#length"}},[e._v("length")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:50"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267")])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"bitlength"}})]),e._v(" "),r("h2",{attrs:{id:"bitlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("bitLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[e._v("U8aFixed")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html#bitlength"}},[e._v("bitLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8aFixed.ts:52"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271")])]),e._v(" "),r("p",[e._v("Returns an array of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("code",[e._v("number")]),e._v("]>")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:58"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("code",[e._v("number")])]),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017")])]),e._v(" "),r("p",[e._v("Returns the elements of an array that meet the condition specified in a callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275")])]),e._v(" "),r("p",[e._v("Returns an list of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("code",[e._v("number")])]),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array, and returns an array that contains the results.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("number")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),e._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[e._v("#")]),e._v(" set")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("set")]),e._v("(array: "),r("em",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(", offset?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.set")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148")])]),e._v(" "),r("p",[e._v("Sets a value or an array of values.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("array")]),e._v(" "),r("td",[r("code",[e._v("ArrayLike")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("td",[e._v("A typed or untyped array of values to set.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" offset")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The index in the current array at which the values are to be written.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"subarray"}})]),e._v(" "),r("h2",{attrs:{id:"subarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subarray","aria-hidden":"true"}},[e._v("#")]),e._v(" subarray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("subarray")]),e._v("(begin: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#subarray"}},[e._v("subarray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.subarray")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:73"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("begin")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to start at")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position to end at")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:80"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185")])]),e._v(" "),r("p",[e._v("Converts a number to a string by using the current locale.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Uint8Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:94"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[e._v("U8a")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/U8a.ts:102"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Uint8Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279")])]),e._v(" "),r("p",[e._v("Returns an list of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/315.984b43a5.js b/docs/assets/js/315.984b43a5.js deleted file mode 100644 index 831774199e..0000000000 --- a/docs/assets/js/315.984b43a5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[315],{517:function(t,e,r){"use strict";r.r(e);var s=r(46),a=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": SignaturePayload")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": A signing payload for an "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")]),t._v(". For the final encoding, it is variable length based on the conetnts included")],1),t._v(" "),r("p",[t._v("8 bytes: The Transaction Index/Nonce as provided in the transaction itself. 2+ bytes: The Function Descriptor as provided in the transaction itself. 2 bytes: The Transaction Era as provided in the transaction itself. 32 bytes: The hash of the authoring block implied by the Transaction Era and the current block.")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ SignaturePayload")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new SignaturePayload")]),t._v("(value?: "),r("em",[r("code",[t._v("SignaturePayloadValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("SignaturePayloadValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"blockhash"}})]),t._v(" "),r("h2",{attrs:{id:"blockhash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#blockhash","aria-hidden":"true"}},[t._v("#")]),t._v(" blockHash")]),t._v(" "),r("p",[r("strong",[t._v("get blockHash")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L57",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:57"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The block "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")]),t._v(" the signature applies to (mortal/immortal)")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"era"}})]),t._v(" "),r("h2",{attrs:{id:"era"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#era","aria-hidden":"true"}},[t._v("#")]),t._v(" era")]),t._v(" "),r("p",[r("strong",[t._v("get era")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:71"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"issigned"}})]),t._v(" "),r("h2",{attrs:{id:"issigned"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#issigned","aria-hidden":"true"}},[t._v("#")]),t._v(" isSigned")]),t._v(" "),r("p",[r("strong",[t._v("get isSigned")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:50"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": "),r("code",[t._v("true")]),t._v(" if the payload refers to a valid signature")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"method"}})]),t._v(" "),r("h2",{attrs:{id:"method"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),r("p",[r("strong",[t._v("get method")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:64"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")]),t._v(" contained in the payload")],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"nonce"}})]),t._v(" "),r("h2",{attrs:{id:"nonce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nonce","aria-hidden":"true"}},[t._v("#")]),t._v(" nonce")]),t._v(" "),r("p",[r("strong",[t._v("get nonce")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:78"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The "),r("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signature"}})]),t._v(" "),r("h2",{attrs:{id:"signature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signature","aria-hidden":"true"}},[t._v("#")]),t._v(" signature")]),t._v(" "),r("p",[r("strong",[t._v("get signature")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:85"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The raw signature as a "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(signerPair: "),r("em",[r("code",[t._v("KeyringPair")])]),t._v(", version?: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L96",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/SignaturePayload.ts:96"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Sign the payload with the keypair")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("signerPair")]),t._v(" "),r("td",[r("code",[t._v("KeyringPair")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" version")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/316.0c709a9e.js b/docs/assets/js/316.0c709a9e.js deleted file mode 100644 index f4c73f1b77..0000000000 --- a/docs/assets/js/316.0c709a9e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[316],{304:function(e,t,r){"use strict";r.r(t);var _=r(46),v=Object(_.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": NextAuthority")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The next authority available as "),r("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[e._v("SessionKey")])],1),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ NextAuthority")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[n: "),r("code",[e._v("number")]),e._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new NextAuthority")]),e._v("(value?: "),r("em",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("router-link",{attrs:{to:"/types/modules/_type_storedpendingchange_.html#nextauthorityvalue"}},[e._v("NextAuthorityValue")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[e._v("NextAuthority")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/StoredPendingChange.ts:30"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),r("td",[r("code",[e._v("Uint8Array")]),e._v(" | "),r("router-link",{attrs:{to:"/types/modules/_type_storedpendingchange_.html#nextauthorityvalue"}},[e._v("NextAuthorityValue")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[e._v("NextAuthority")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),e._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[e._v("#")]),e._v(" length")]),e._v(" "),r("p",[r("strong",[e._v("● length")]),e._v(": "),r("em",[r("code",[e._v("number")])])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.length")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209")])]),e._v(" "),r("p",[e._v("Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.")]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#types","aria-hidden":"true"}},[e._v("#")]),e._v(" Types")]),e._v(" "),r("p",[r("strong",[e._v("get Types")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#types"}},[e._v("Types")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:75"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The types definition of the tuple")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("string")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:59"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"index"}})]),e._v(" "),r("h2",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" index")]),e._v(" "),r("p",[r("strong",[e._v("get index")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/StoredPendingChange.ts:38"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[e._v("U64")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:68"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sessionkey"}})]),e._v(" "),r("h2",{attrs:{id:"sessionkey"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sessionkey","aria-hidden":"true"}},[e._v("#")]),e._v(" sessionKey")]),e._v(" "),r("p",[r("strong",[e._v("get sessionKey")]),e._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[e._v("SessionKey")])],1),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L42",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/StoredPendingChange.ts:42"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[e._v("SessionKey")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),e._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[e._v("#")]),e._v(" __@iterator")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@iterator")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.iterator]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52")])]),e._v(" "),r("p",[e._v("Iterator")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"___unscopables"}})]),e._v(" "),r("h2",{attrs:{id:"unscopables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unscopables","aria-hidden":"true"}},[e._v("#")]),e._v(" __@unscopables")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__@unscopables")]),e._v("(): "),r("code",[e._v("object")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.[Symbol.unscopables]")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94")])]),e._v(" "),r("p",[e._v("Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("object")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"concat"}})]),e._v(" "),r("h2",{attrs:{id:"concat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#concat","aria-hidden":"true"}},[e._v("#")]),e._v(" concat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("concat")]),e._v("(...items: "),r("em",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("code",[e._v("ConcatArray")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">[]")],1),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.concat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236")])]),e._v(" "),r("p",[e._v("Combines two or more arrays.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[e._v("("),r("code",[e._v("T")]),e._v(" | "),r("code",[e._v("ConcatArray")]),e._v("<"),r("code",[e._v("T")]),e._v(">)[]")]),e._v(" "),r("td",[e._v("Additional items to add to the end of array1.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"copywithin"}})]),e._v(" "),r("h2",{attrs:{id:"copywithin"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#copywithin","aria-hidden":"true"}},[e._v("#")]),e._v(" copyWithin")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("copyWithin")]),e._v("(target: "),r("em",[r("code",[e._v("number")])]),e._v(", start: "),r("em",[r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.copyWithin")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64")])]),e._v(" "),r("p",[e._v("Returns the this object after copying a section of the array identified by start and end to the same array starting at position target")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("target")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If target is negative, it is treated as length+target where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("If not specified, length of the this object is used as its default value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),e._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[e._v("#")]),e._v(" entries")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("entries")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.entries")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57")])]),e._v(" "),r("p",[e._v("Returns an iterable of key, value pairs for every entry in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<["),r("code",[e._v("number")]),e._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("]>")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"every"}})]),e._v(" "),r("h2",{attrs:{id:"every"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#every","aria-hidden":"true"}},[e._v("#")]),e._v(" every")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("every")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.every")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296")])]),e._v(" "),r("p",[e._v("Determines whether all the members of an array satisfy the specified test.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"fill"}})]),e._v(" "),r("h2",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill","aria-hidden":"true"}},[e._v("#")]),e._v(" fill")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("fill")]),e._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.fill")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53")])]),e._v(" "),r("p",[e._v("Returns the this object after filling the section identified by start and end with value")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("value to fill array section with")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("index to stop filling the array at. If end is negative, it is treated as length+end.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"filter"}})]),e._v(" "),r("h2",{attrs:{id:"filter"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#filter","aria-hidden":"true"}},[e._v("#")]),e._v(" filter")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("filter")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#filter"}},[e._v("filter")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.filter")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Filters the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The filter function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` object to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"find"}})]),e._v(" "),r("h2",{attrs:{id:"find"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#find","aria-hidden":"true"}},[e._v("#")]),e._v(" find")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("<"),r("code",[e._v("S")]),e._v(">(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("find")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31")])]),e._v(" "),r("p",[e._v("Returns the value of the first element in the array where predicate is true, and undefined otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"s-codec"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-codec","aria-hidden":"true"}},[e._v("#")]),e._v(" S : "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("S")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.find")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"findindex"}})]),e._v(" "),r("h2",{attrs:{id:"findindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#findindex","aria-hidden":"true"}},[e._v("#")]),e._v(" findIndex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("findIndex")]),e._v("(predicate: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.findIndex")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43")])]),e._v(" "),r("p",[e._v("Returns the index of the first element in the array where predicate is true, and -1 otherwise.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("predicate")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flat"}})]),e._v(" "),r("h2",{attrs:{id:"flat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flat","aria-hidden":"true"}},[e._v("#")]),e._v(" flat")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("7")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("6")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("5")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("4")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("3")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(", depth: "),r("em",[r("code",[e._v("2")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[][]")]),e._v(", depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(this: "),r("em",[r("code",[e._v("U")]),e._v("[]")]),e._v(", depth: "),r("em",[r("code",[e._v("0")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flat")]),e._v("<"),r("code",[e._v("U")]),e._v(">(depth?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("7")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-2","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("6")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-3","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("5")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-4","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("4")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-5","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("3")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-6","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("2")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-7","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[][]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("1")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-8","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("this")]),e._v(" "),r("td",[r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("td")]),e._v(" "),r("tr",[r("td",[e._v("depth")]),e._v(" "),r("td",[r("code",[e._v("0")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flat")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222")])]),e._v(" "),r("p",[e._v("Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-9","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" depth")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The maximum recursion depth")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"flatmap"}})]),e._v(" "),r("h2",{attrs:{id:"flatmap"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#flatmap","aria-hidden":"true"}},[e._v("#")]),e._v(" flatMap")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("flatMap")]),e._v("<"),r("code",[e._v("U")]),e._v(","),r("code",[e._v("This")]),e._v(">(callback: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v("): "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.flatMap")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147")])]),e._v(" "),r("p",[e._v("Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-10","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("h4",{attrs:{id:"this"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#this","aria-hidden":"true"}},[e._v("#")]),e._v(" This")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callback")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("a",{attrs:{href:""}},[e._v("This")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")]),e._v("[]")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),e._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[e._v("#")]),e._v(" forEach")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("forEach")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("void")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.forEach")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308")])]),e._v(" "),r("p",[e._v("Performs the specified action for each element in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("void")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"includes"}})]),e._v(" "),r("h2",{attrs:{id:"includes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#includes","aria-hidden":"true"}},[e._v("#")]),e._v(" includes")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("includes")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.includes")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27")])]),e._v(" "),r("p",[e._v("Determines whether an array includes a certain element, returning true or false as appropriate.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The element to search for.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The position in this array at which to begin searching for searchElement.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"indexof"}})]),e._v(" "),r("h2",{attrs:{id:"indexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexof","aria-hidden":"true"}},[e._v("#")]),e._v(" indexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("indexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.indexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284")])]),e._v(" "),r("p",[e._v("Returns the index of the first occurrence of a value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"join"}})]),e._v(" "),r("h2",{attrs:{id:"join"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#join","aria-hidden":"true"}},[e._v("#")]),e._v(" join")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("join")]),e._v("(separator?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v("): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.join")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241")])]),e._v(" "),r("p",[e._v("Adds all the elements of an array separated by the specified separator string.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" separator")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("string")])]),e._v(" "),r("td",[e._v("A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),e._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[e._v("#")]),e._v(" keys")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("keys")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.keys")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62")])]),e._v(" "),r("p",[e._v("Returns an iterable of keys in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("code",[e._v("number")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"lastindexof"}})]),e._v(" "),r("h2",{attrs:{id:"lastindexof"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#lastindexof","aria-hidden":"true"}},[e._v("#")]),e._v(" lastIndexOf")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("lastIndexOf")]),e._v("(searchElement: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(", fromIndex?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.lastIndexOf")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290")])]),e._v(" "),r("p",[e._v("Returns the index of the last occurrence of a specified value in an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("searchElement")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("td",[e._v("The value to locate in the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" fromIndex")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"map"}})]),e._v(" "),r("h2",{attrs:{id:"map"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#map","aria-hidden":"true"}},[e._v("#")]),e._v(" map")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("map")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#map"}},[e._v("map")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.map")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:149"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Maps the array with the callback")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-11","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The mapping function")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("The `this` onject to apply the result to")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("U")]),e._v(">")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"pop"}})]),e._v(" "),r("h2",{attrs:{id:"pop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pop","aria-hidden":"true"}},[e._v("#")]),e._v(" pop")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("pop")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.pop")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221")])]),e._v(" "),r("p",[e._v("Removes the last element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"push"}})]),e._v(" "),r("h2",{attrs:{id:"push"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#push","aria-hidden":"true"}},[e._v("#")]),e._v(" push")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("push")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.push")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226")])]),e._v(" "),r("p",[e._v("Appends new elements to an array, and returns the new length of the array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("New elements of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduce"}})]),e._v(" "),r("h2",{attrs:{id:"reduce"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduce","aria-hidden":"true"}},[e._v("#")]),e._v(" reduce")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduce")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduce")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-12","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reduceright"}})]),e._v(" "),r("h2",{attrs:{id:"reduceright"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reduceright","aria-hidden":"true"}},[e._v("#")]),e._v(" reduceRight")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reduceRight")]),e._v("<"),r("code",[e._v("U")]),e._v(">(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", initialValue: "),r("em",[r("code",[e._v("U")])]),e._v("): "),r("code",[e._v("U")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346")])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reduceRight")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352")])]),e._v(" "),r("p",[e._v("Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.")]),e._v(" "),r("p",[r("strong",[e._v("Type parameters:")])]),e._v(" "),r("h4",{attrs:{id:"u-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u-13","aria-hidden":"true"}},[e._v("#")]),e._v(" U")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.")])]),e._v(" "),r("tr",[r("td",[e._v("initialValue")]),e._v(" "),r("td",[r("code",[e._v("U")])]),e._v(" "),r("td",[e._v("If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("U")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"reverse"}})]),e._v(" "),r("h2",{attrs:{id:"reverse"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reverse","aria-hidden":"true"}},[e._v("#")]),e._v(" reverse")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("reverse")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.reverse")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245")])]),e._v(" "),r("p",[e._v("Reverses the elements in an Array.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"shift"}})]),e._v(" "),r("h2",{attrs:{id:"shift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#shift","aria-hidden":"true"}},[e._v("#")]),e._v(" shift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("shift")]),e._v("(): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.shift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249")])]),e._v(" "),r("p",[e._v("Removes the first element from an array and returns it.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(" | "),r("code",[e._v("undefined")])],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"slice"}})]),e._v(" "),r("h2",{attrs:{id:"slice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#slice","aria-hidden":"true"}},[e._v("#")]),e._v(" slice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("slice")]),e._v("(start?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(", end?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.slice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255")])]),e._v(" "),r("p",[e._v("Returns a section of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" start")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The beginning of the specified portion of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" end")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The end of the specified portion of the array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"some"}})]),e._v(" "),r("h2",{attrs:{id:"some"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#some","aria-hidden":"true"}},[e._v("#")]),e._v(" some")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("some")]),e._v("(callbackfn: "),r("em",[r("code",[e._v("function")])]),e._v(", thisArg?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.some")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302")])]),e._v(" "),r("p",[e._v("Determines whether the specified callback function returns true for any element of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("callbackfn")]),e._v(" "),r("td",[r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" thisArg")]),e._v(" "),r("td",[r("code",[e._v("any")])]),e._v(" "),r("td",[e._v("An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"sort"}})]),e._v(" "),r("h2",{attrs:{id:"sort"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sort","aria-hidden":"true"}},[e._v("#")]),e._v(" sort")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("sort")]),e._v("(compareFn?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v("): "),r("code",[e._v("this")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.sort")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260")])]),e._v(" "),r("p",[e._v("Sorts an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" compareFn")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("function")])]),e._v(" "),r("td",[e._v("The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("this")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"splice"}})]),e._v(" "),r("h2",{attrs:{id:"splice"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#splice","aria-hidden":"true"}},[e._v("#")]),e._v(" splice")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("splice")]),e._v("(start: "),r("em",[r("code",[e._v("number")])]),e._v(", deleteCount: "),r("em",[r("code",[e._v("number")])]),e._v(", ...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" deleteCount")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.splice")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273")])]),e._v(" "),r("p",[e._v("Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("start")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The zero-based location in the array from which to start removing elements.")])]),e._v(" "),r("tr",[r("td",[e._v("deleteCount")]),e._v(" "),r("td",[r("code",[e._v("number")])]),e._v(" "),r("td",[e._v("The number of elements to remove.")])]),e._v(" "),r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert into the array in place of the deleted elements.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),e._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toArray")]),e._v("(): "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#toarray"}},[e._v("toArray")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to an standard JavaScript Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Array")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tolocalestring"}})]),e._v(" "),r("h2",{attrs:{id:"tolocalestring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tolocalestring","aria-hidden":"true"}},[e._v("#")]),e._v(" toLocaleString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toLocaleString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.toLocaleString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217")])]),e._v(" "),r("p",[e._v("Returns a string representation of an array. The elements are converted to string using their toLocalString methods.")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Overrides Array.toString")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:114"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:123"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"unshift"}})]),e._v(" "),r("h2",{attrs:{id:"unshift"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unshift","aria-hidden":"true"}},[e._v("#")]),e._v(" unshift")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("unshift")]),e._v("(...items: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v("): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.unshift")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278")])]),e._v(" "),r("p",[e._v("Inserts new elements at the start of an array.")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" items")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("[]")],1),e._v(" "),r("td",[e._v("Elements to insert at the start of the Array.")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),e._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[e._v("#")]),e._v(" values")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("values")]),e._v("(): "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from Array.values")])]),e._v(" "),r("p",[r("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67")])]),e._v(" "),r("p",[e._v("Returns an iterable of values in the array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("IterableIterator")]),e._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v(">")],1),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),e._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" with")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("with")]),e._v("(Types: "),r("em",[r("code",[e._v("TupleConstructors")])]),e._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html#with"}},[e._v("with")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Tuple.ts:48"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("Types")]),e._v(" "),r("td",[r("code",[e._v("TupleConstructors")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[e._v("Constructor")]),e._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[e._v("Tuple")]),e._v(">")],1),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/317.60e8df6c.js b/docs/assets/js/317.60e8df6c.js deleted file mode 100644 index 4182bcff0a..0000000000 --- a/docs/assets/js/317.60e8df6c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[317],{514:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": StoredPendingChange")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Stored pending change for a Grandpa events")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ StoredPendingChange")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new StoredPendingChange")]),t._v("(value?: "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_type_storedpendingchange_.html#storedpendingchangevalue"}},[t._v("StoredPendingChangeValue")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("StoredPendingChange")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/StoredPendingChange.ts:52"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("router-link",{attrs:{to:"/types/modules/_type_storedpendingchange_.html#storedpendingchangevalue"}},[t._v("StoredPendingChangeValue")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("StoredPendingChange")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delay"}})]),t._v(" "),r("h2",{attrs:{id:"delay"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delay","aria-hidden":"true"}},[t._v("#")]),t._v(" delay")]),t._v(" "),r("p",[r("strong",[t._v("get delay")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/StoredPendingChange.ts:64"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"nextauthorities"}})]),t._v(" "),r("h2",{attrs:{id:"nextauthorities"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#nextauthorities","aria-hidden":"true"}},[t._v("#")]),t._v(" nextAuthorities")]),t._v(" "),r("p",[r("strong",[t._v("get nextAuthorities")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[t._v("NextAuthority")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/StoredPendingChange.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[t._v("NextAuthority")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"scheduledat"}})]),t._v(" "),r("h2",{attrs:{id:"scheduledat"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#scheduledat","aria-hidden":"true"}},[t._v("#")]),t._v(" scheduledAt")]),t._v(" "),r("p",[r("strong",[t._v("get scheduledAt")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/StoredPendingChange.ts:72"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/318.c630d384.js b/docs/assets/js/318.c630d384.js deleted file mode 100644 index 4b3d6bd1b3..0000000000 --- a/docs/assets/js/318.c630d384.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[318],{508:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": ValidatorPrefs")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Validator preferences")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ ValidatorPrefs")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new ValidatorPrefs")]),t._v("(value?: "),r("em",[r("code",[t._v("ValidatorPrefsValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ValidatorPrefs.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ValidatorPrefs.ts:22"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("ValidatorPrefsValue")]),t._v(" | "),r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"unstakethreshold"}})]),t._v(" "),r("h2",{attrs:{id:"unstakethreshold"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#unstakethreshold","aria-hidden":"true"}},[t._v("#")]),t._v(" unstakeThreshold")]),t._v(" "),r("p",[r("strong",[t._v("get unstakeThreshold")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ValidatorPrefs.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ValidatorPrefs.ts:33"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The unstake threshold as "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"validatorpayment"}})]),t._v(" "),r("h2",{attrs:{id:"validatorpayment"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#validatorpayment","aria-hidden":"true"}},[t._v("#")]),t._v(" validatorPayment")]),t._v(" "),r("p",[r("strong",[t._v("get validatorPayment")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ValidatorPrefs.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ValidatorPrefs.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The payment config for the validator as a "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/319.b2671ca4.js b/docs/assets/js/319.b2671ca4.js deleted file mode 100644 index 2ab3c835c8..0000000000 --- a/docs/assets/js/319.b2671ca4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[319],{511:function(t,e,r){"use strict";r.r(e);var s=r(46),_=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("p",[r("em",[r("strong",[t._v("name")])]),t._v(": VestingSchedule")]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Struct to encode the vesting schedule of an individual account")]),t._v(" "),r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[t._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),r("p",[r("strong",[t._v("↳ VestingSchedule")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new VestingSchedule")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("VestingSchedule")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VestingSchedule.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/VestingSchedule.ts:12"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("VestingSchedule")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#type"}},[t._v("Type")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#encodedlength"}},[t._v("encodedLength")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#isempty"}},[t._v("isEmpty")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"offset"}})]),t._v(" "),r("h2",{attrs:{id:"offset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#offset","aria-hidden":"true"}},[t._v("#")]),t._v(" offset")]),t._v(" "),r("p",[r("strong",[t._v("get offset")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VestingSchedule.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/VestingSchedule.ts:23"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The offset as "),r("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"perblock"}})]),t._v(" "),r("h2",{attrs:{id:"perblock"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#perblock","aria-hidden":"true"}},[t._v("#")]),t._v(" perBlock")]),t._v(" "),r("p",[r("strong",[t._v("get perBlock")]),t._v("(): "),r("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VestingSchedule.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/VestingSchedule.ts:30"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The perBlock value as "),r("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("]>")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#eq"}},[t._v("eq")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#get"}},[t._v("get")])],1)]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#getatindex"}},[t._v("getAtIndex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#toarray"}},[t._v("toArray")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tohex"}},[t._v("toHex")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tojson"}},[t._v("toJSON")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tostring"}},[t._v("toString")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#tou8a"}},[t._v("toU8a")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("p",[r("em",[t._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html#with"}},[t._v("with")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("<"),r("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/32.d1cfa31f.js b/docs/assets/js/32.d1cfa31f.js deleted file mode 100644 index 23e54386e5..0000000000 --- a/docs/assets/js/32.d1cfa31f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{369:function(e,t,r){"use strict";r.r(t);var n=r(46),a=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"referendums"}})]),e._v(" "),r("h2",{attrs:{id:"referendums"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#referendums","aria-hidden":"true"}},[e._v("#")]),e._v(" referendums")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("referendums")]),e._v("(api: "),r("em",[r("code",[e._v("ApiInterface$Rx")])]),e._v("): "),r("code",[e._v("(Anonymous function)")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendums.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendums.ts:14"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("api")]),e._v(" "),r("td",[r("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("(Anonymous function)")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/320.afbbd029.js b/docs/assets/js/320.afbbd029.js deleted file mode 100644 index 4af9d9e688..0000000000 --- a/docs/assets/js/320.afbbd029.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[320],{303:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": Vote")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": A number of lock periods, plus a vote, one way or the other.")]),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[e._v("I8")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ Vote")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new Vote")]),e._v("(value?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[e._v("Vote")])],1),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[e._v("I8")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Vote.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Vote.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[e._v("Vote")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isaye"}})]),e._v(" "),v("h2",{attrs:{id:"isaye"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isaye","aria-hidden":"true"}},[e._v("#")]),e._v(" isAye")]),e._v(" "),v("p",[v("strong",[e._v("get isAye")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Vote.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Vote.ts:32"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true is the wrapped value is a positive vote")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isnay"}})]),e._v(" "),v("h2",{attrs:{id:"isnay"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isnay","aria-hidden":"true"}},[e._v("#")]),e._v(" isNay")]),e._v(" "),v("p",[v("strong",[e._v("get isNay")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Vote.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Vote.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true is the wrapped value is a negative vote")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[e._v("Int")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Int.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/321.339d71c2.js b/docs/assets/js/321.339d71c2.js deleted file mode 100644 index 6f610ab471..0000000000 --- a/docs/assets/js/321.339d71c2.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[321],{529:function(e,t,v){"use strict";v.r(t);var _=v(46),r=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("p",[v("em",[v("strong",[e._v("name")])]),e._v(": VoteIndex")]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Voting index, implemented as a "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("h1",{attrs:{id:"hierarchy"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),v("p",[e._v("↳ "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")])],1),e._v(" "),v("p",[v("strong",[e._v("↳ VoteIndex")])]),e._v(" "),v("h1",{attrs:{id:"implements"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),v("ul",[v("li",[v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),v("h1",{attrs:{id:"constructors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),v("p",[v("a",{attrs:{id:"constructor"}})]),e._v(" "),v("h2",{attrs:{id:"constructor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),v("p",[e._v("⊕ "),v("strong",[e._v("new VoteIndex")]),e._v("(value?: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v("): "),v("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[e._v("VoteIndex")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[e._v("U32")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("primitive/U32.ts:14"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[e._v("VoteIndex")])],1),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"accessors"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),v("p",[v("a",{attrs:{id:"encodedlength"}})]),e._v(" "),v("h2",{attrs:{id:"encodedlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),v("p",[v("strong",[e._v("get encodedLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.encodedLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:64"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isempty"}})]),e._v(" "),v("h2",{attrs:{id:"isempty"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),v("p",[v("strong",[e._v("get isEmpty")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.isEmpty")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:71"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Checks if the value is a zero value (align elsewhere)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("h1",{attrs:{id:"methods"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),v("p",[v("a",{attrs:{id:"abs"}})]),e._v(" "),v("h2",{attrs:{id:"abs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#abs","aria-hidden":"true"}},[e._v("#")]),e._v(" abs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("abs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.abs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"add"}})]),e._v(" "),v("h2",{attrs:{id:"add"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#add","aria-hidden":"true"}},[e._v("#")]),e._v(" add")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("add")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.add")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"addn"}})]),e._v(" "),v("h2",{attrs:{id:"addn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#addn","aria-hidden":"true"}},[e._v("#")]),e._v(" addn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("addn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.addn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"and"}})]),e._v(" "),v("h2",{attrs:{id:"and"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#and","aria-hidden":"true"}},[e._v("#")]),e._v(" and")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("and")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.and")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"andln"}})]),e._v(" "),v("h2",{attrs:{id:"andln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#andln","aria-hidden":"true"}},[e._v("#")]),e._v(" andln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("andln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.andln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and (NOTE: "),v("code",[e._v("andln")]),e._v(" is going to be replaced with "),v("code",[e._v("andn")]),e._v(" in future)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bincn"}})]),e._v(" "),v("h2",{attrs:{id:"bincn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bincn","aria-hidden":"true"}},[e._v("#")]),e._v(" bincn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bincn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.bincn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": add "),v("code",[e._v("1 << b")]),e._v(" to the number")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bitlength"}})]),e._v(" "),v("h2",{attrs:{id:"bitlength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bitlength","aria-hidden":"true"}},[e._v("#")]),e._v(" bitLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("bitLength")]),e._v("(): "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.bitLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:78"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the number of bits in the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"bytelength"}})]),e._v(" "),v("h2",{attrs:{id:"bytelength"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#bytelength","aria-hidden":"true"}},[e._v("#")]),e._v(" byteLength")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("byteLength")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.byteLength")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of bytes occupied")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"clone"}})]),e._v(" "),v("h2",{attrs:{id:"clone"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[e._v("#")]),e._v(" clone")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("clone")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.clone")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clone number")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmp"}})]),e._v(" "),v("h2",{attrs:{id:"cmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmp","aria-hidden":"true"}},[e._v("#")]),e._v(" cmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"cmpn"}})]),e._v(" "),v("h2",{attrs:{id:"cmpn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#cmpn","aria-hidden":"true"}},[e._v("#")]),e._v(" cmpn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("cmpn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.cmpn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"div"}})]),e._v(" "),v("h2",{attrs:{id:"div"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#div","aria-hidden":"true"}},[e._v("#")]),e._v(" div")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("div")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.div")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divround"}})]),e._v(" "),v("h2",{attrs:{id:"divround"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divround","aria-hidden":"true"}},[e._v("#")]),e._v(" divRound")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divRound")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divRound")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": rounded division")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"divn"}})]),e._v(" "),v("h2",{attrs:{id:"divn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#divn","aria-hidden":"true"}},[e._v("#")]),e._v(" divn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("divn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.divn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"egcd"}})]),e._v(" "),v("h2",{attrs:{id:"egcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#egcd","aria-hidden":"true"}},[e._v("#")]),e._v(" egcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("egcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("object")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.egcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Extended GCD results "),v("code",[e._v("({ a: ..., b: ..., gcd: ... })")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("object")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eq"}})]),e._v(" "),v("h2",{attrs:{id:"eq"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eq")]),e._v("(other?: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.eq")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.eq")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:85"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"eqn"}})]),e._v(" "),v("h2",{attrs:{id:"eqn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#eqn","aria-hidden":"true"}},[e._v("#")]),e._v(" eqn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("eqn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.eqn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"fromtwos"}})]),e._v(" "),v("h2",{attrs:{id:"fromtwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#fromtwos","aria-hidden":"true"}},[e._v("#")]),e._v(" fromTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("fromTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.fromTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert from two's complement representation, where width is the bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gcd"}})]),e._v(" "),v("h2",{attrs:{id:"gcd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gcd","aria-hidden":"true"}},[e._v("#")]),e._v(" gcd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gcd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gcd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": GCD")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gt"}})]),e._v(" "),v("h2",{attrs:{id:"gt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gt","aria-hidden":"true"}},[e._v("#")]),e._v(" gt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gte"}})]),e._v(" "),v("h2",{attrs:{id:"gte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gte","aria-hidden":"true"}},[e._v("#")]),e._v(" gte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gten"}})]),e._v(" "),v("h2",{attrs:{id:"gten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gten","aria-hidden":"true"}},[e._v("#")]),e._v(" gten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"gtn"}})]),e._v(" "),v("h2",{attrs:{id:"gtn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#gtn","aria-hidden":"true"}},[e._v("#")]),e._v(" gtn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("gtn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.gtn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a greater than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iabs"}})]),e._v(" "),v("h2",{attrs:{id:"iabs"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iabs","aria-hidden":"true"}},[e._v("#")]),e._v(" iabs")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iabs")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iabs")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": absolute value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iadd"}})]),e._v(" "),v("h2",{attrs:{id:"iadd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iadd","aria-hidden":"true"}},[e._v("#")]),e._v(" iadd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iadd")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iadd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iaddn"}})]),e._v(" "),v("h2",{attrs:{id:"iaddn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iaddn","aria-hidden":"true"}},[e._v("#")]),e._v(" iaddn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iaddn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iaddn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": addition")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iand"}})]),e._v(" "),v("h2",{attrs:{id:"iand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iand","aria-hidden":"true"}},[e._v("#")]),e._v(" iand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"idivn"}})]),e._v(" "),v("h2",{attrs:{id:"idivn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#idivn","aria-hidden":"true"}},[e._v("#")]),e._v(" idivn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("idivn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.idivn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": divide")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imaskn"}})]),e._v(" "),v("h2",{attrs:{id:"imaskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imaskn","aria-hidden":"true"}},[e._v("#")]),e._v(" imaskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imaskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imaskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imul"}})]),e._v(" "),v("h2",{attrs:{id:"imul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imul","aria-hidden":"true"}},[e._v("#")]),e._v(" imul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"imuln"}})]),e._v(" "),v("h2",{attrs:{id:"imuln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#imuln","aria-hidden":"true"}},[e._v("#")]),e._v(" imuln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("imuln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.imuln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ineg"}})]),e._v(" "),v("h2",{attrs:{id:"ineg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ineg","aria-hidden":"true"}},[e._v("#")]),e._v(" ineg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ineg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ineg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"inotn"}})]),e._v(" "),v("h2",{attrs:{id:"inotn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#inotn","aria-hidden":"true"}},[e._v("#")]),e._v(" inotn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("inotn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.inotn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"invm"}})]),e._v(" "),v("h2",{attrs:{id:"invm"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#invm","aria-hidden":"true"}},[e._v("#")]),e._v(" invm")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("invm")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.invm")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": inverse "),v("code",[e._v("a")]),e._v(" modulo "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ior"}})]),e._v(" "),v("h2",{attrs:{id:"ior"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ior","aria-hidden":"true"}},[e._v("#")]),e._v(" ior")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ior")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ior")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iseven"}})]),e._v(" "),v("h2",{attrs:{id:"iseven"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iseven","aria-hidden":"true"}},[e._v("#")]),e._v(" isEven")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isEven")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isEven")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is even")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isneg"}})]),e._v(" "),v("h2",{attrs:{id:"isneg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isneg","aria-hidden":"true"}},[e._v("#")]),e._v(" isNeg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isNeg")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isNeg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": true if the number is negative")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isodd"}})]),e._v(" "),v("h2",{attrs:{id:"isodd"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isodd","aria-hidden":"true"}},[e._v("#")]),e._v(" isOdd")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isOdd")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isOdd")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is odd")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iszero"}})]),e._v(" "),v("h2",{attrs:{id:"iszero"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iszero","aria-hidden":"true"}},[e._v("#")]),e._v(" isZero")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isZero")]),e._v("(): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isZero")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": check if value is zero")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishln"}})]),e._v(" "),v("h2",{attrs:{id:"ishln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishln","aria-hidden":"true"}},[e._v("#")]),e._v(" ishln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ishrn"}})]),e._v(" "),v("h2",{attrs:{id:"ishrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ishrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ishrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ishrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ishrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right (unimplemented "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086"),v("OutboundLink")],1),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isqr"}})]),e._v(" "),v("h2",{attrs:{id:"isqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isqr","aria-hidden":"true"}},[e._v("#")]),e._v(" isqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isub"}})]),e._v(" "),v("h2",{attrs:{id:"isub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isub","aria-hidden":"true"}},[e._v("#")]),e._v(" isub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isubn"}})]),e._v(" "),v("h2",{attrs:{id:"isubn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#isubn","aria-hidden":"true"}},[e._v("#")]),e._v(" isubn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isubn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isubn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuand"}})]),e._v(" "),v("h2",{attrs:{id:"iuand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuand","aria-hidden":"true"}},[e._v("#")]),e._v(" iuand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuor"}})]),e._v(" "),v("h2",{attrs:{id:"iuor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushln"}})]),e._v(" "),v("h2",{attrs:{id:"iushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushln","aria-hidden":"true"}},[e._v("#")]),e._v(" iushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iushrn"}})]),e._v(" "),v("h2",{attrs:{id:"iushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" iushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"iuxor"}})]),e._v(" "),v("h2",{attrs:{id:"iuxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#iuxor","aria-hidden":"true"}},[e._v("#")]),e._v(" iuxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("iuxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.iuxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ixor"}})]),e._v(" "),v("h2",{attrs:{id:"ixor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ixor","aria-hidden":"true"}},[e._v("#")]),e._v(" ixor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ixor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ixor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lt"}})]),e._v(" "),v("h2",{attrs:{id:"lt"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lt","aria-hidden":"true"}},[e._v("#")]),e._v(" lt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lt")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lte"}})]),e._v(" "),v("h2",{attrs:{id:"lte"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lte","aria-hidden":"true"}},[e._v("#")]),e._v(" lte")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lte")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lte")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"lten"}})]),e._v(" "),v("h2",{attrs:{id:"lten"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#lten","aria-hidden":"true"}},[e._v("#")]),e._v(" lten")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("lten")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.lten")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than or equals b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ltn"}})]),e._v(" "),v("h2",{attrs:{id:"ltn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ltn","aria-hidden":"true"}},[e._v("#")]),e._v(" ltn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ltn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ltn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": a less than b")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"maskn"}})]),e._v(" "),v("h2",{attrs:{id:"maskn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#maskn","aria-hidden":"true"}},[e._v("#")]),e._v(" maskn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("maskn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.maskn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": clear bits with indexes higher or equal to "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mod"}})]),e._v(" "),v("h2",{attrs:{id:"mod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mod","aria-hidden":"true"}},[e._v("#")]),e._v(" mod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"modn"}})]),e._v(" "),v("h2",{attrs:{id:"modn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#modn","aria-hidden":"true"}},[e._v("#")]),e._v(" modn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("modn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.modn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("see")])]),e._v(": API consistency "),v("a",{attrs:{href:"https://github.com/indutny/bn.js/pull/130",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/indutny/bn.js/pull/130"),v("OutboundLink")],1)]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mul"}})]),e._v(" "),v("h2",{attrs:{id:"mul"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#mul","aria-hidden":"true"}},[e._v("#")]),e._v(" mul")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mul")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mul")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"muln"}})]),e._v(" "),v("h2",{attrs:{id:"muln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#muln","aria-hidden":"true"}},[e._v("#")]),e._v(" muln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("muln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.muln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": multiply")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"neg"}})]),e._v(" "),v("h2",{attrs:{id:"neg"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#neg","aria-hidden":"true"}},[e._v("#")]),e._v(" neg")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("neg")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.neg")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": negate sign")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"notn"}})]),e._v(" "),v("h2",{attrs:{id:"notn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#notn","aria-hidden":"true"}},[e._v("#")]),e._v(" notn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("notn")]),e._v("(w: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.notn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": not (for the width specified by "),v("code",[e._v("w")]),e._v(")")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("w")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"or"}})]),e._v(" "),v("h2",{attrs:{id:"or"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#or","aria-hidden":"true"}},[e._v("#")]),e._v(" or")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("or")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.or")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"pow"}})]),e._v(" "),v("h2",{attrs:{id:"pow"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#pow","aria-hidden":"true"}},[e._v("#")]),e._v(" pow")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pow")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.pow")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": raise "),v("code",[e._v("a")]),e._v(" to the power of "),v("code",[e._v("b")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"setn"}})]),e._v(" "),v("h2",{attrs:{id:"setn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#setn","aria-hidden":"true"}},[e._v("#")]),e._v(" setn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("setn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.setn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": set specified bit to 1")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shln"}})]),e._v(" "),v("h2",{attrs:{id:"shln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shln","aria-hidden":"true"}},[e._v("#")]),e._v(" shln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"shrn"}})]),e._v(" "),v("h2",{attrs:{id:"shrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#shrn","aria-hidden":"true"}},[e._v("#")]),e._v(" shrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("shrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.shrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sqr"}})]),e._v(" "),v("h2",{attrs:{id:"sqr"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sqr","aria-hidden":"true"}},[e._v("#")]),e._v(" sqr")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sqr")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sqr")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": square")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"sub"}})]),e._v(" "),v("h2",{attrs:{id:"sub"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#sub","aria-hidden":"true"}},[e._v("#")]),e._v(" sub")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("sub")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.sub")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"subn"}})]),e._v(" "),v("h2",{attrs:{id:"subn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#subn","aria-hidden":"true"}},[e._v("#")]),e._v(" subn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.subn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": subtraction")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"testn"}})]),e._v(" "),v("h2",{attrs:{id:"testn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#testn","aria-hidden":"true"}},[e._v("#")]),e._v(" testn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("testn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.testn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": test if specified bit is set")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarray"}})]),e._v(" "),v("h2",{attrs:{id:"toarray"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[e._v("#")]),e._v(" toArray")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArray")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArray")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to byte Array, and optionally zero pad to length, throwing if already exceeding")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"toarraylike"}})]),e._v(" "),v("h2",{attrs:{id:"toarraylike"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#toarraylike","aria-hidden":"true"}},[e._v("#")]),e._v(" toArrayLike")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("object")])]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toArrayLike")]),e._v("(ArrayType: "),v("em",[v("code",[e._v("any")]),e._v("[]")]),e._v(", endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to an instance of "),v("code",[e._v("type")]),e._v(", which must behave like an Array")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toArrayLike")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96")])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("ArrayType")]),e._v(" "),v("td",[v("code",[e._v("any")]),e._v("[]")])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")]),e._v("[]")]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobn"}})]),e._v(" "),v("h2",{attrs:{id:"tobn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobn","aria-hidden":"true"}},[e._v("#")]),e._v(" toBn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBn")]),e._v("(): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toBn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:98"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the BN representation of the number. (Compatibility)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tobuffer"}})]),e._v(" "),v("h2",{attrs:{id:"tobuffer"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tobuffer","aria-hidden":"true"}},[e._v("#")]),e._v(" toBuffer")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toBuffer")]),e._v("(endian?: "),v("em",[v("code",[e._v("Endianness")])]),e._v(", length?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("Buffer")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toBuffer")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" endian")]),e._v(" "),v("td",[v("code",[e._v("Endianness")])])]),e._v(" "),v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" length")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Buffer")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tohex"}})]),e._v(" "),v("h2",{attrs:{id:"tohex"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toHex")]),e._v("(): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toHex")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:36"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tojson"}})]),e._v(" "),v("h2",{attrs:{id:"tojson"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toJSON")]),e._v("(): "),v("code",[e._v("any")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toJSON")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:110"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("any")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tonumber"}})]),e._v(" "),v("h2",{attrs:{id:"tonumber"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toNumber")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toNumber")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to Javascript Number (limited to 53 bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tored"}})]),e._v(" "),v("h2",{attrs:{id:"tored"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tored","aria-hidden":"true"}},[e._v("#")]),e._v(" toRed")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toRed")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("ReductionContext")])]),e._v("): "),v("code",[e._v("RedBN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toRed")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Convert number to red")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("ReductionContext")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("RedBN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tostring"}})]),e._v(" "),v("h2",{attrs:{id:"tostring"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toString")]),e._v("(base?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.toString")])]),e._v(" "),v("p",[v("em",[e._v("Overrides BN.toString")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:121"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" base")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("number")])]),e._v(" "),v("td",[e._v("The base to use for the conversion")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"totwos"}})]),e._v(" "),v("h2",{attrs:{id:"totwos"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#totwos","aria-hidden":"true"}},[e._v("#")]),e._v(" toTwos")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toTwos")]),e._v("(width: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.toTwos")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": convert to two's complement representation, where width is bit width")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("width")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"tou8a"}})]),e._v(" "),v("h2",{attrs:{id:"tou8a"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("toU8a")]),e._v("(isBare?: "),v("em",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v("): "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("p",[v("em",[e._v("Implementation of "),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),v("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Inherited from "),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[e._v("UInt")]),e._v("."),v("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),v("p",[v("em",[e._v("Overrides AbstractInt.toU8a")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/UInt.ts:48"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")]),e._v(" "),v("th",[e._v("Description")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[v("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),v("td",[v("code",[e._v("undefined")]),e._v(" | "),v("code",[e._v("false")]),e._v(" | "),v("code",[e._v("true")])]),e._v(" "),v("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Uint8Array")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uand"}})]),e._v(" "),v("h2",{attrs:{id:"uand"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uand","aria-hidden":"true"}},[e._v("#")]),e._v(" uand")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uand")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uand")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": and")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ucmp"}})]),e._v(" "),v("h2",{attrs:{id:"ucmp"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ucmp","aria-hidden":"true"}},[e._v("#")]),e._v(" ucmp")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ucmp")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ucmp")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": compare numbers and return "),v("code",[e._v("-1 (a < b)")]),e._v(", "),v("code",[e._v("0 (a == b)")]),e._v(", or "),v("code",[e._v("1 (a > b)")]),e._v(" depending on the comparison result")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("-1")]),e._v(" | "),v("code",[e._v("0")]),e._v(" | "),v("code",[e._v("1")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"umod"}})]),e._v(" "),v("h2",{attrs:{id:"umod"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#umod","aria-hidden":"true"}},[e._v("#")]),e._v(" umod")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("umod")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.umod")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": reduct")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uor"}})]),e._v(" "),v("h2",{attrs:{id:"uor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uor","aria-hidden":"true"}},[e._v("#")]),e._v(" uor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": or")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushln"}})]),e._v(" "),v("h2",{attrs:{id:"ushln"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushln","aria-hidden":"true"}},[e._v("#")]),e._v(" ushln")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushln")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushln")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift left")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"ushrn"}})]),e._v(" "),v("h2",{attrs:{id:"ushrn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#ushrn","aria-hidden":"true"}},[e._v("#")]),e._v(" ushrn")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("ushrn")]),e._v("(b: "),v("em",[v("code",[e._v("number")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.ushrn")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": shift right")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("number")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"uxor"}})]),e._v(" "),v("h2",{attrs:{id:"uxor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#uxor","aria-hidden":"true"}},[e._v("#")]),e._v(" uxor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("uxor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.uxor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"xor"}})]),e._v(" "),v("h2",{attrs:{id:"xor"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#xor","aria-hidden":"true"}},[e._v("#")]),e._v(" xor")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("xor")]),e._v("(b: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.xor")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": xor")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"zerobits"}})]),e._v(" "),v("h2",{attrs:{id:"zerobits"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#zerobits","aria-hidden":"true"}},[e._v("#")]),e._v(" zeroBits")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("zeroBits")]),e._v("(): "),v("code",[e._v("number")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.zeroBits")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)")]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("number")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"decodeabstracint"}})]),e._v(" "),v("h2",{attrs:{id:"static-decodeabstracint"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeabstracint","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" decodeAbstracInt")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("decodeAbstracInt")]),e._v("(value: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1),e._v(", bitLength: "),v("em",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1),e._v(", isNegative: "),v("em",[v("code",[e._v("boolean")])]),e._v("): "),v("code",[e._v("string")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from AbstractInt.decodeAbstracInt")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/AbstractInt.ts:39"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("value")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[e._v("AnyNumber")])],1)]),e._v(" "),v("tr",[v("td",[e._v("bitLength")]),e._v(" "),v("td",[v("router-link",{attrs:{to:"/types/modules/_codec_abstractint_.html#uintbitlength"}},[e._v("UIntBitLength")])],1)]),e._v(" "),v("tr",[v("td",[e._v("isNegative")]),e._v(" "),v("td",[v("code",[e._v("boolean")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("string")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"isbn"}})]),e._v(" "),v("h2",{attrs:{id:"static-isbn"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-isbn","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" isBN")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("isBN")]),e._v("(b: "),v("em",[v("code",[e._v("any")])]),e._v("): "),v("code",[e._v("boolean")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.isBN")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns true if the supplied object is a BN.js instance")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("b")]),e._v(" "),v("td",[v("code",[e._v("any")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("boolean")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"max"}})]),e._v(" "),v("h2",{attrs:{id:"static-max"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-max","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" max")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("max")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.max")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the maximum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"min"}})]),e._v(" "),v("h2",{attrs:{id:"static-min"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-min","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" min")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("min")]),e._v("(left: "),v("em",[v("code",[e._v("BN")])]),e._v(", right: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("BN")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.min")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": returns the minimum of 2 BN instances.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("left")]),e._v(" "),v("td",[v("code",[e._v("BN")])])]),e._v(" "),v("tr",[v("td",[e._v("right")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("BN")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"mont"}})]),e._v(" "),v("h2",{attrs:{id:"static-mont"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-mont","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" mont")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("mont")]),e._v("(num: "),v("em",[v("code",[e._v("BN")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.mont")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context with the Montgomery trick.")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("num")]),e._v(" "),v("td",[v("code",[e._v("BN")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr"),e._v(" "),v("p",[v("a",{attrs:{id:"red"}})]),e._v(" "),v("h2",{attrs:{id:"static-red"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#static-red","aria-hidden":"true"}},[e._v("#")]),e._v(" "),v("code",[e._v("")]),e._v(" red")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("red")]),e._v("(reductionContext: "),v("em",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])]),e._v("): "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("p",[v("em",[e._v("Inherited from BN.red")])]),e._v(" "),v("p",[v("em",[e._v("Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40")])]),e._v(" "),v("p",[v("em",[v("strong",[e._v("description")])]),e._v(": create a reduction context")]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("reductionContext")]),e._v(" "),v("td",[v("code",[e._v("BN")]),e._v(" | "),v("code",[e._v("IPrimeName")])])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("ReductionContext")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/322.e9f5bb56.js b/docs/assets/js/322.e9f5bb56.js deleted file mode 100644 index f3e441fe81..0000000000 --- a/docs/assets/js/322.e9f5bb56.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[322],{567:function(e,t,r){"use strict";r.r(t);var s=r(46),o=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("p",[r("em",[r("strong",[e._v("name")])]),e._v(": VoteThreshold")]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Voting threshold, used inside proposals to set change the voting tally")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[e._v("↳ "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")])],1),e._v(" "),r("p",[r("strong",[e._v("↳ VoteThreshold")])]),e._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[e._v("#")]),e._v(" Implements")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")])],1)]),e._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[e._v("#")]),e._v(" Constructors")]),e._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),e._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[e._v("#")]),e._v(" constructor")]),e._v(" "),r("p",[e._v("⊕ "),r("strong",[e._v("new VoteThreshold")]),e._v("(index?: "),r("em",[r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("Uint8Array")])]),e._v("): "),r("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[e._v("VoteThreshold")])],1),e._v(" "),r("p",[r("em",[e._v("Overrides "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#constructor"}},[e._v("constructor")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VoteThreshold.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/VoteThreshold.ts:12"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" index")]),e._v(" "),r("td",[r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("Uint8Array")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[e._v("VoteThreshold")])],1),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[e._v("#")]),e._v(" Accessors")]),e._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),e._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[e._v("#")]),e._v(" encodedLength")]),e._v(" "),r("p",[r("strong",[e._v("get encodedLength")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#encodedlength"}},[e._v("encodedLength")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:64"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The length of the value when encoded as a Uint8Array")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),e._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[e._v("#")]),e._v(" isEmpty")]),e._v(" "),r("p",[r("strong",[e._v("get isEmpty")]),e._v("(): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#isempty"}},[e._v("isEmpty")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:71"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Checks if the value is an empty value (always false)")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[e._v("#")]),e._v(" Methods")]),e._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),e._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[e._v("#")]),e._v(" eq")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("eq")]),e._v("(other?: "),r("em",[r("code",[e._v("any")])]),e._v("): "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#eq"}},[e._v("eq")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:78"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Compares the value of the input to see if there is a match")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" other")]),e._v(" "),r("td",[r("code",[e._v("any")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("boolean")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),e._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[e._v("#")]),e._v(" toHex")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toHex")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tohex"}},[e._v("toHex")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:91"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns a hex string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),e._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[e._v("#")]),e._v(" toJSON")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toJSON")]),e._v("(): "),r("code",[e._v("any")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tojson"}},[e._v("toJSON")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:98"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Converts the Object to JSON, typically used for RPC transfers")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("any")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tonumber"}})]),e._v(" "),r("h2",{attrs:{id:"tonumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tonumber","aria-hidden":"true"}},[e._v("#")]),e._v(" toNumber")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toNumber")]),e._v("(): "),r("code",[e._v("number")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tonumber"}},[e._v("toNumber")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:105"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the number representation for the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),e._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[e._v("#")]),e._v(" toString")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toString")]),e._v("(): "),r("code",[e._v("string")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tostring"}},[e._v("toString")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:112"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Returns the string representation of the value")]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("string")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),e._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[e._v("#")]),e._v(" toU8a")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("toU8a")]),e._v("(isBare?: "),r("em",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v("): "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("p",[r("em",[e._v("Implementation of "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[e._v("Codec")]),e._v("."),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#tou8a"}},[e._v("toU8a")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:120"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")]),e._v(" "),r("th",[e._v("Description")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Optional")]),e._v(" isBare")]),e._v(" "),r("td",[r("code",[e._v("undefined")]),e._v(" | "),r("code",[e._v("false")]),e._v(" | "),r("code",[e._v("true")])]),e._v(" "),r("td",[e._v("true when the value has none of the type-specific prefixes (internal)")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("Uint8Array")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"decodeenum"}})]),e._v(" "),r("h2",{attrs:{id:"static-decodeenum"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeenum","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" decodeEnum")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("decodeEnum")]),e._v("(def: "),r("em",[r("code",[e._v("EnumDef")])]),e._v(", value: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1),e._v("): "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("p",[r("em",[e._v("Inherited from "),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v("."),r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html#decodeenum"}},[e._v("decodeEnum")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/Enum.ts:47"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("def")]),e._v(" "),r("td",[r("code",[e._v("EnumDef")])])]),e._v(" "),r("tr",[r("td",[e._v("value")]),e._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[e._v("Enum")]),e._v(" | "),r("code",[e._v("Uint8Array")]),e._v(" | "),r("code",[e._v("string")]),e._v(" | "),r("code",[e._v("number")])],1)])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("number")]),e._v(" | "),r("code",[e._v("undefined")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/323.18234317.js b/docs/assets/js/323.18234317.js deleted file mode 100644 index 810a5bcccd..0000000000 --- a/docs/assets/js/323.18234317.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[323],{569:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"enumeration-members"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumeration members")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#compact"}},[e._v("Compact")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#enum"}},[e._v("Enum")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#option"}},[e._v("Option")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#plain"}},[e._v("Plain")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#struct"}},[e._v("Struct")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#tuple"}},[e._v("Tuple")])],1),e._v(" "),r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html#vector"}},[e._v("Vector")])],1)]),e._v(" "),r("hr"),e._v(" "),r("h1",{attrs:{id:"enumeration-members-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Enumeration members")]),e._v(" "),r("p",[r("a",{attrs:{id:"compact"}})]),e._v(" "),r("h2",{attrs:{id:"compact"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#compact","aria-hidden":"true"}},[e._v("#")]),e._v(" Compact")]),e._v(" "),r("p",[r("strong",[e._v("Compact")]),e._v(":")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/createType.ts:19"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"enum"}})]),e._v(" "),r("h2",{attrs:{id:"enum"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enum","aria-hidden":"true"}},[e._v("#")]),e._v(" Enum")]),e._v(" "),r("p",[r("strong",[e._v("Enum")]),e._v(":")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/createType.ts:20"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"option"}})]),e._v(" "),r("h2",{attrs:{id:"option"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#option","aria-hidden":"true"}},[e._v("#")]),e._v(" Option")]),e._v(" "),r("p",[r("strong",[e._v("Option")]),e._v(":")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/createType.ts:21"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"plain"}})]),e._v(" "),r("h2",{attrs:{id:"plain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#plain","aria-hidden":"true"}},[e._v("#")]),e._v(" Plain")]),e._v(" "),r("p",[r("strong",[e._v("Plain")]),e._v(":")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/createType.ts:22"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"struct"}})]),e._v(" "),r("h2",{attrs:{id:"struct"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#struct","aria-hidden":"true"}},[e._v("#")]),e._v(" Struct")]),e._v(" "),r("p",[r("strong",[e._v("Struct")]),e._v(":")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/createType.ts:23"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tuple"}})]),e._v(" "),r("h2",{attrs:{id:"tuple"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tuple","aria-hidden":"true"}},[e._v("#")]),e._v(" Tuple")]),e._v(" "),r("p",[r("strong",[e._v("Tuple")]),e._v(":")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/createType.ts:24"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"vector"}})]),e._v(" "),r("h2",{attrs:{id:"vector"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#vector","aria-hidden":"true"}},[e._v("#")]),e._v(" Vector")]),e._v(" "),r("p",[r("strong",[e._v("Vector")]),e._v(":")]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("codec/createType.ts:25"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/324.876d6fa4.js b/docs/assets/js/324.876d6fa4.js deleted file mode 100644 index be835407f9..0000000000 --- a/docs/assets/js/324.876d6fa4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[324],{570:function(t,a,e){"use strict";e.r(a);var r=e(46),s=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("MetadataInterface")])]),t._v(" "),e("h1",{attrs:{id:"implemented-by"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1)]),t._v(" "),e("h1",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("p",[e("a",{attrs:{id:"getuniqtypes"}})]),t._v(" "),e("h2",{attrs:{id:"getuniqtypes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getuniqtypes","aria-hidden":"true"}},[t._v("#")]),t._v(" getUniqTypes")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getUniqTypes")]),t._v("(throwError: "),e("em",[e("code",[t._v("boolean")])]),t._v("): "),e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("string")]),t._v(">")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/types.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/types.ts:6"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("throwError")]),t._v(" "),e("td",[e("code",[t._v("boolean")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("string")]),t._v(">")]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/325.760b9745.js b/docs/assets/js/325.760b9745.js deleted file mode 100644 index 14a27d60c2..0000000000 --- a/docs/assets/js/325.760b9745.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[325],{572:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("strong",[t._v("MethodFunction")])]),t._v(" "),a("h1",{attrs:{id:"callable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#callable","aria-hidden":"true"}},[t._v("#")]),t._v(" Callable")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("__call")]),t._v("(...args: "),a("em",[a("code",[t._v("any")]),t._v("[]")]),t._v("): "),a("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:28"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Rest")]),t._v(" args")]),t._v(" "),a("td",[a("code",[t._v("any")]),t._v("[]")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),a("p",[a("a",{attrs:{id:"callindex"}})]),t._v(" "),a("h2",{attrs:{id:"callindex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#callindex","aria-hidden":"true"}},[t._v("#")]),t._v(" callIndex")]),t._v(" "),a("p",[a("strong",[t._v("● callIndex")]),t._v(": "),a("em",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:30"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"meta"}})]),t._v(" "),a("h2",{attrs:{id:"meta"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),a("p",[a("strong",[t._v("● meta")]),t._v(": "),a("em",[a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:31"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"method"}})]),t._v(" "),a("h2",{attrs:{id:"method"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),a("p",[a("strong",[t._v("● method")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:32"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"section"}})]),t._v(" "),a("h2",{attrs:{id:"section"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#section","aria-hidden":"true"}},[t._v("#")]),t._v(" section")]),t._v(" "),a("p",[a("strong",[t._v("● section")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:33"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tojson"}})]),t._v(" "),a("h2",{attrs:{id:"tojson"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),a("p",[a("strong",[t._v("● toJSON")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/Method.ts:34"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(): "),a("code",[t._v("any")])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("any")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/326.6d4fa02d.js b/docs/assets/js/326.6d4fa02d.js deleted file mode 100644 index 47d67b3929..0000000000 --- a/docs/assets/js/326.6d4fa02d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[326],{573:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("Methods")])]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[key: "),r("code",[t._v("string")]),t._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methodfunction.html"}},[t._v("MethodFunction")])],1)])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/327.281fe456.js b/docs/assets/js/327.281fe456.js deleted file mode 100644 index 4b1f36ef76..0000000000 --- a/docs/assets/js/327.281fe456.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[327],{575:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("ModulesWithMethods")])]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[key: "),r("code",[t._v("string")]),t._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methods.html"}},[t._v("Methods")])],1)])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/328.c5495c85.js b/docs/assets/js/328.c5495c85.js deleted file mode 100644 index 541e9b71cb..0000000000 --- a/docs/assets/js/328.c5495c85.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[328],{576:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("strong",[t._v("StorageFunction")])]),t._v(" "),a("h1",{attrs:{id:"callable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#callable","aria-hidden":"true"}},[t._v("#")]),t._v(" Callable")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("__call")]),t._v("(arg?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/StorageKey.ts:12"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" arg")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),a("p",[a("a",{attrs:{id:"meta"}})]),t._v(" "),a("h2",{attrs:{id:"meta"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),a("p",[a("strong",[t._v("● meta")]),t._v(": "),a("em",[a("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/StorageKey.ts:14"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"method"}})]),t._v(" "),a("h2",{attrs:{id:"method"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),a("p",[a("strong",[t._v("● method")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/StorageKey.ts:15"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"section"}})]),t._v(" "),a("h2",{attrs:{id:"section"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#section","aria-hidden":"true"}},[t._v("#")]),t._v(" section")]),t._v(" "),a("p",[a("strong",[t._v("● section")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/StorageKey.ts:16"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tojson"}})]),t._v(" "),a("h2",{attrs:{id:"tojson"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),a("p",[a("strong",[t._v("● toJSON")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("primitive/StorageKey.ts:17"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(): "),a("code",[t._v("any")])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("any")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/329.ed360faa.js b/docs/assets/js/329.ed360faa.js deleted file mode 100644 index d175098653..0000000000 --- a/docs/assets/js/329.ed360faa.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[329],{505:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("p",[s("em",[s("strong",[t._v("name")])]),t._v(": Codec")]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": The base Codec interface. All types implement the interface provided here. Additionally implementors can add their own specific interfaces and helpres with getters and functions. The Codec Base is however required for operating as an encoding/decoding layer")]),t._v(" "),s("h1",{attrs:{id:"hierarchy"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),s("p",[s("strong",[t._v("Codec")])]),t._v(" "),s("h1",{attrs:{id:"implemented-by"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountidof.html"}},[t._v("AccountIdOf")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("AccountIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[t._v("Amount")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[t._v("ApiId")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[t._v("ApplyExtrinsic")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[t._v("AssetOf")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[t._v("AuthoritiesChange")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("AuthorityId")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.availabilityvote.html"}},[t._v("AvailabilityVote")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[t._v("BalanceOf")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.balanceupload.html"}},[t._v("BalanceUpload")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("BftAuthoritySignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[t._v("BftDoubleCommit")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[t._v("BftDoublePrepare")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[t._v("BftDoublePropose")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("BftProposeOutOfTurn")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[t._v("Block")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("CandidateReceipt")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[t._v("CandidateSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_chainproperties_.chainproperties.html"}},[t._v("ChainProperties")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[t._v("ChangesTrieRoot")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[t._v("CodeHash")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[t._v("Data")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.default.html"}},[t._v("Default")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[t._v("DigestItem")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.ed25519signature.html"}},[t._v("Ed25519Signature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.egressqueueroot.html"}},[t._v("EgressQueueRoot")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[t._v("Enum")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("EventData")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[t._v("EventIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("ExplicitCandidateSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("Extrinsics")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[t._v("Finalised")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[t._v("Finalization")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[t._v("H160")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[t._v("H256")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[t._v("H512")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.headdata.html"}},[t._v("HeadData")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[t._v("Header")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[t._v("HeaderExtended")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_health_.health.html"}},[t._v("Health")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[t._v("I128")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[t._v("I16")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[t._v("I256")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[t._v("I32")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[t._v("I64")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[t._v("I8")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("ImplicitCandidateSignature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[t._v("InherentOfflineReport")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[t._v("Int")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[t._v("KeyValue")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[t._v("KeyValueOption")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_lockperiods_.lockperiods.html"}},[t._v("LocKPeriods")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[t._v("MagicNumber")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[t._v("MetadataCall")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[t._v("MetadataCallArg")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[t._v("MetadataStorageModifier")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[t._v("MetadataStorageType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.methodindex.html"}},[t._v("MethodIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[t._v("MisbehaviorKind")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.momentof.html"}},[t._v("MomentOf")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_networkstate_.networkstate.html"}},[t._v("NetworkState")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[t._v("NewAccountOutcome")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[t._v("NextAuthority")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_noncecompact_.noncecompact.html"}},[t._v("NonceCompact")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.optional.html"}},[t._v("Optional")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("Origin")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[t._v("Other")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("OuterDispatchMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("OuterEventMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[t._v("ParaId")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_peerinfo_.peerinfo.html"}},[t._v("PeerInfo")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html"}},[t._v("PendingExtrinsics")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[t._v("Perbill")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[t._v("Permill")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[t._v("PlainType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[t._v("PrefabWasmModule")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[t._v("PropIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[t._v("ProposalIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[t._v("ReferendumIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[t._v("ReferendumInfo")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("RhdJustification")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[t._v("RuntimeVersionApi")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[t._v("Schedule")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[t._v("Seal")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[t._v("SeedOf")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[t._v("SessionKey")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[t._v("Set")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_signedblock_.signedblock.html"}},[t._v("SignedBlock")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.sr25519signature.html"}},[t._v("Sr25519Signature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("StorageData")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[t._v("StorageFunctionModifier")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[t._v("StorageFunctionType")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("StorageKey")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[t._v("StoredPendingChange")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[t._v("U128")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[t._v("U256")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[t._v("U64")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[t._v("U8")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[t._v("U8a")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[t._v("U8aFixed")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[t._v("Usurped")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityattestation.html"}},[t._v("ValidityAttestation")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityvote.html"}},[t._v("ValidityVote")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[t._v("VestingSchedule")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[t._v("Vote")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[t._v("VoteIndex")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[t._v("VoteThreshold")])],1)]),t._v(" "),s("h1",{attrs:{id:"properties"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),s("p",[s("a",{attrs:{id:"encodedlength"}})]),t._v(" "),s("h2",{attrs:{id:"encodedlength"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),s("p",[s("strong",[t._v("● encodedLength")]),t._v(": "),s("em",[s("code",[t._v("number")])])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:34"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"isempty"}})]),t._v(" "),s("h2",{attrs:{id:"isempty"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),s("p",[s("strong",[t._v("● isEmpty")]),t._v(": "),s("em",[s("code",[t._v("boolean")])])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:39"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),s("hr"),t._v(" "),s("h1",{attrs:{id:"methods"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),s("p",[s("a",{attrs:{id:"eq"}})]),t._v(" "),s("h2",{attrs:{id:"eq"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("eq")]),t._v("(other?: "),s("em",[s("code",[t._v("any")])]),t._v("): "),s("code",[t._v("boolean")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:44"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),s("td",[s("code",[t._v("any")])])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("boolean")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tohex"}})]),t._v(" "),s("h2",{attrs:{id:"tohex"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toHex")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:49"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tojson"}})]),t._v(" "),s("h2",{attrs:{id:"tojson"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toJSON")]),t._v("(): "),s("code",[t._v("any")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:54"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("any")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tostring"}})]),t._v(" "),s("h2",{attrs:{id:"tostring"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toString")]),t._v("(): "),s("code",[t._v("string")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L59",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:59"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("string")])]),t._v(" "),s("hr"),t._v(" "),s("p",[s("a",{attrs:{id:"tou8a"}})]),t._v(" "),s("h2",{attrs:{id:"tou8a"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("toU8a")]),t._v("(isBare?: "),s("em",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("false")]),t._v(" | "),s("code",[t._v("true")])]),t._v("): "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L65",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:65"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("em",[s("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),s("p",[s("strong",[t._v("Parameters:")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),s("td",[s("code",[t._v("undefined")]),t._v(" | "),s("code",[t._v("false")]),t._v(" | "),s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Uint8Array")])]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/33.8a0e0669.js b/docs/assets/js/33.8a0e0669.js deleted file mode 100644 index ec0a489b9e..0000000000 --- a/docs/assets/js/33.8a0e0669.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{370:function(e,t,r){"use strict";r.r(t);var n=r(46),o=Object(n.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),r("p",[r("a",{attrs:{id:"referendumvotesfor"}})]),e._v(" "),r("h2",{attrs:{id:"referendumvotesfor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#referendumvotesfor","aria-hidden":"true"}},[e._v("#")]),e._v(" referendumVotesFor")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("referendumVotesFor")]),e._v("(api: "),r("em",[r("code",[e._v("ApiInterface$Rx")])]),e._v("): "),r("code",[e._v("(Anonymous function)")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/referendumVotesFor.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[e._v("democracy/referendumVotesFor.ts:16"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[e._v("api")]),e._v(" "),r("td",[r("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("(Anonymous function)")])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/330.f19292df.js b/docs/assets/js/330.f19292df.js deleted file mode 100644 index d4fbb23e90..0000000000 --- a/docs/assets/js/330.f19292df.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[330],{578:function(t,r,e){"use strict";e.r(r);var a=e(46),s=Object(a.a)({},function(){var t=this,r=t.$createElement,e=t._self._c||r;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("h4",{attrs:{id:"t"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#t","aria-hidden":"true"}},[t._v("#")]),t._v(" T")]),t._v(" "),e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("strong",[t._v("Constructor")])]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new Constructor")]),t._v("(...value: "),e("em",[e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("any")]),t._v(">")]),t._v("): "),e("code",[t._v("T")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L70",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:70"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Rest")]),t._v(" value")]),t._v(" "),e("td",[e("code",[t._v("Array")]),t._v("<"),e("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("T")])]),t._v(" "),e("hr")])},[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/331.4c61687a.js b/docs/assets/js/331.4c61687a.js deleted file mode 100644 index 7e98f5d0d2..0000000000 --- a/docs/assets/js/331.4c61687a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[331],{579:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("RuntimeVersionInterface")])]),e._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[e._v("#")]),e._v(" Implemented by")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[e._v("RuntimeVersion")])],1)]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"apis"}})]),e._v(" "),r("h2",{attrs:{id:"apis"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#apis","aria-hidden":"true"}},[e._v("#")]),e._v(" apis")]),e._v(" "),r("p",[r("strong",[e._v("● apis")]),e._v(": "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("any")]),e._v(">")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:83"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"authoringversion"}})]),e._v(" "),r("h2",{attrs:{id:"authoringversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#authoringversion","aria-hidden":"true"}},[e._v("#")]),e._v(" authoringVersion")]),e._v(" "),r("p",[r("strong",[e._v("● authoringVersion")]),e._v(": "),r("em",[r("code",[e._v("BN")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:84"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"implname"}})]),e._v(" "),r("h2",{attrs:{id:"implname"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implname","aria-hidden":"true"}},[e._v("#")]),e._v(" implName")]),e._v(" "),r("p",[r("strong",[e._v("● implName")]),e._v(": "),r("em",[r("code",[e._v("String")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L85",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:85"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"implversion"}})]),e._v(" "),r("h2",{attrs:{id:"implversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implversion","aria-hidden":"true"}},[e._v("#")]),e._v(" implVersion")]),e._v(" "),r("p",[r("strong",[e._v("● implVersion")]),e._v(": "),r("em",[r("code",[e._v("BN")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L86",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:86"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"specname"}})]),e._v(" "),r("h2",{attrs:{id:"specname"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#specname","aria-hidden":"true"}},[e._v("#")]),e._v(" specName")]),e._v(" "),r("p",[r("strong",[e._v("● specName")]),e._v(": "),r("em",[r("code",[e._v("String")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L87",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:87"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"specversion"}})]),e._v(" "),r("h2",{attrs:{id:"specversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#specversion","aria-hidden":"true"}},[e._v("#")]),e._v(" specVersion")]),e._v(" "),r("p",[r("strong",[e._v("● specVersion")]),e._v(": "),r("em",[r("code",[e._v("BN")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:88"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/332.a3d97398.js b/docs/assets/js/332.a3d97398.js deleted file mode 100644 index 27d464a5b7..0000000000 --- a/docs/assets/js/332.a3d97398.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[332],{581:function(e,t,s){"use strict";s.r(t);var a=s(46),r=Object(a.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"type-aliases"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),s("p",[s("a",{attrs:{id:"codectypes"}})]),e._v(" "),s("h2",{attrs:{id:"codectypes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#codectypes","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecTypes")]),e._v(" "),s("p",[s("strong",[e._v("Ƭ CodecTypes")]),e._v(": "),s("em",[s("code",[e._v('keyof "/home/travis/build/polkadot-js/api/packages/types/src/index.types"')])])]),e._v(" "),s("p",[s("em",[e._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/classes.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[e._v("classes.ts:7"),s("OutboundLink")],1)])]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/333.59e4acd9.js b/docs/assets/js/333.59e4acd9.js deleted file mode 100644 index 0cba64bac1..0000000000 --- a/docs/assets/js/333.59e4acd9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[333],{582:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),a("p",[a("a",{attrs:{id:"uintbitlength"}})]),t._v(" "),a("h2",{attrs:{id:"uintbitlength"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#uintbitlength","aria-hidden":"true"}},[t._v("#")]),t._v(" UIntBitLength")]),t._v(" "),a("p",[a("strong",[t._v("Ƭ UIntBitLength")]),t._v(": "),a("em",[a("code",[t._v("8")]),t._v(" | "),a("code",[t._v("16")]),t._v(" | "),a("code",[t._v("32")]),t._v(" | "),a("code",[t._v("64")]),t._v(" | "),a("code",[t._v("128")]),t._v(" | "),a("code",[t._v("256")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/AbstractInt.ts:10"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"variables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("p",[a("a",{attrs:{id:"default_uint_bits"}})]),t._v(" "),a("h2",{attrs:{id:"const-default-uint-bits"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-default-uint-bits","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" DEFAULT_UINT_BITS")]),t._v(" "),a("p",[a("strong",[t._v("● DEFAULT_UINT_BITS")]),t._v(": "),a("em",[a("code",[t._v("64")])]),t._v(" = 64")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/AbstractInt.ts:12"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/334.50b4fc9a.js b/docs/assets/js/334.50b4fc9a.js deleted file mode 100644 index 988626663a..0000000000 --- a/docs/assets/js/334.50b4fc9a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[334],{584:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_codec_base_.base.html"}},[t._v("Base")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/335.8601cab4.js b/docs/assets/js/335.8601cab4.js deleted file mode 100644 index b40f0bb717..0000000000 --- a/docs/assets/js/335.8601cab4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[335],{585:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_codec_compact_.compact.html"}},[t._v("Compact")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/336.e5fe146e.js b/docs/assets/js/336.e5fe146e.js deleted file mode 100644 index abecba914c..0000000000 --- a/docs/assets/js/336.e5fe146e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[336],{587:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"enumerations"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#enumerations","aria-hidden":"true"}},[t._v("#")]),t._v(" Enumerations")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/enums/_codec_createtype_.typedefinfo.html"}},[t._v("TypeDefInfo")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#typedef"}},[t._v("TypeDef")])],1)]),t._v(" "),r("h3",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#createclass"}},[t._v("createClass")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#createtype"}},[t._v("createType")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#gettypeclass"}},[t._v("getTypeClass")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#gettypedef"}},[t._v("getTypeDef")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#typesplit"}},[t._v("typeSplit")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"typedef"}})]),t._v(" "),r("h2",{attrs:{id:"typedef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#typedef","aria-hidden":"true"}},[t._v("#")]),t._v(" TypeDef")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ TypeDef")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/createType.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"functions-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"createclass"}})]),t._v(" "),r("h2",{attrs:{id:"createclass"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createclass","aria-hidden":"true"}},[t._v("#")]),t._v(" createClass")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createClass")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")])],1),t._v(", value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L195",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/createType.ts:195"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")])],1)]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"createtype"}})]),t._v(" "),r("h2",{attrs:{id:"createtype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#createtype","aria-hidden":"true"}},[t._v("#")]),t._v(" createType")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("createType")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")])],1),t._v(", value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L201",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/createType.ts:201"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")])],1)]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"gettypeclass"}})]),t._v(" "),r("h2",{attrs:{id:"gettypeclass"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#gettypeclass","aria-hidden":"true"}},[t._v("#")]),t._v(" getTypeClass")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getTypeClass")]),t._v("(value: "),r("em",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#typedef"}},[t._v("TypeDef")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L139",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/createType.ts:139"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#typedef"}},[t._v("TypeDef")])],1)])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"gettypedef"}})]),t._v(" "),r("h2",{attrs:{id:"gettypedef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#gettypedef","aria-hidden":"true"}},[t._v("#")]),t._v(" getTypeDef")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getTypeDef")]),t._v("(_type: "),r("em",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")])],1),t._v(", name?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])]),t._v("): "),r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#typedef"}},[t._v("TypeDef")])],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L84",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/createType.ts:84"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("_type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")]),t._v(" | "),r("code",[t._v("string")])],1)]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" name")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/modules/_codec_createtype_.html#typedef"}},[t._v("TypeDef")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"typesplit"}})]),t._v(" "),r("h2",{attrs:{id:"typesplit"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#typesplit","aria-hidden":"true"}},[t._v("#")]),t._v(" typeSplit")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("typeSplit")]),t._v("(type: "),r("em",[r("code",[t._v("string")])]),t._v("): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/createType.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("code",[t._v("string")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("string")]),t._v(">")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/337.34dc215b.js b/docs/assets/js/337.34dc215b.js deleted file mode 100644 index 306ed03972..0000000000 --- a/docs/assets/js/337.34dc215b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[337],{588:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enum_.enum.html"}},[t._v("Enum")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/338.e2dbfeee.js b/docs/assets/js/338.e2dbfeee.js deleted file mode 100644 index 939cae4920..0000000000 --- a/docs/assets/js/338.e2dbfeee.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[338],{590:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_enumtype_.enumtype.html"}},[t._v("EnumType")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/339.86dcca2a.js b/docs/assets/js/339.86dcca2a.js deleted file mode 100644 index 70206f17ce..0000000000 --- a/docs/assets/js/339.86dcca2a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[339],{591:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_codec_int_.int.html"}},[t._v("Int")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/34.b504662f.js b/docs/assets/js/34.b504662f.js deleted file mode 100644 index 740f5ffa31..0000000000 --- a/docs/assets/js/34.b504662f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{372:function(t,e,r){"use strict";r.r(e);var a=r(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"votes"}})]),t._v(" "),r("h2",{attrs:{id:"votes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#votes","aria-hidden":"true"}},[t._v("#")]),t._v(" votes")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("votes")]),t._v("(api: "),r("em",[r("code",[t._v("ApiInterface$Rx")])]),t._v("): "),r("code",[t._v("(Anonymous function)")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/democracy/votes.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("democracy/votes.ts:12"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("api")]),t._v(" "),r("td",[r("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("(Anonymous function)")])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/340.fb493bcb.js b/docs/assets/js/340.fb493bcb.js deleted file mode 100644 index 64c296a13d..0000000000 --- a/docs/assets/js/340.fb493bcb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[340],{593:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_codec_option_.option.html"}},[t._v("Option")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/341.7793a420.js b/docs/assets/js/341.7793a420.js deleted file mode 100644 index 26e3ef5432..0000000000 --- a/docs/assets/js/341.7793a420.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[341],{594:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_set_.set.html"}},[t._v("Set")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/342.894cba5f.js b/docs/assets/js/342.894cba5f.js deleted file mode 100644 index 2c4e9a6825..0000000000 --- a/docs/assets/js/342.894cba5f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[342],{596:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_codec_struct_.struct.html"}},[t._v("Struct")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/343.808d0d4b.js b/docs/assets/js/343.808d0d4b.js deleted file mode 100644 index e1a607a0cb..0000000000 --- a/docs/assets/js/343.808d0d4b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[343],{597:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_tuple_.tuple.html"}},[t._v("Tuple")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/344.c80cd4fa.js b/docs/assets/js/344.c80cd4fa.js deleted file mode 100644 index a0ad8dbd65..0000000000 --- a/docs/assets/js/344.c80cd4fa.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[344],{599:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_typeregistry_.typeregistry.html"}},[t._v("TypeRegistry")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/345.7c227d05.js b/docs/assets/js/345.7c227d05.js deleted file mode 100644 index ccf87b58bc..0000000000 --- a/docs/assets/js/345.7c227d05.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[345],{600:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_codec_u8a_.u8a.html"}},[t._v("U8a")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/346.b1f040e3.js b/docs/assets/js/346.b1f040e3.js deleted file mode 100644 index 36622b5188..0000000000 --- a/docs/assets/js/346.b1f040e3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[346],{602:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_u8afixed_.u8afixed.html"}},[t._v("U8aFixed")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/347.b45f5f70.js b/docs/assets/js/347.b45f5f70.js deleted file mode 100644 index 20ebf95ed5..0000000000 --- a/docs/assets/js/347.b45f5f70.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[347],{603:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_codec_uint_.uint.html"}},[t._v("UInt")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/348.111d9030.js b/docs/assets/js/348.111d9030.js deleted file mode 100644 index 5accc0a999..0000000000 --- a/docs/assets/js/348.111d9030.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[348],{605:function(r,t,a){"use strict";a.r(t);var e=a(46),o=Object(e.a)({},function(){var r=this,t=r.$createElement,a=r._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[r._v("#")]),r._v(" Functions")]),r._v(" "),a("p",[a("a",{attrs:{id:"comparearray"}})]),r._v(" "),a("h2",{attrs:{id:"comparearray"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#comparearray","aria-hidden":"true"}},[r._v("#")]),r._v(" compareArray")]),r._v(" "),a("p",[r._v("▸ "),a("strong",[r._v("compareArray")]),r._v("(a: "),a("em",[a("code",[r._v("Array")]),r._v("<"),a("code",[r._v("any")]),r._v(">")]),r._v(", b?: "),a("em",[a("code",[r._v("any")])]),r._v("): "),a("code",[r._v("boolean")])]),r._v(" "),a("p",[a("em",[r._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/utils/compareArray.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[r._v("codec/utils/compareArray.ts:9"),a("OutboundLink")],1)])]),r._v(" "),a("p",[a("strong",[r._v("Parameters:")])]),r._v(" "),a("table",[a("thead",[a("tr",[a("th",[r._v("Name")]),r._v(" "),a("th",[r._v("Type")])])]),r._v(" "),a("tbody",[a("tr",[a("td",[r._v("a")]),r._v(" "),a("td",[a("code",[r._v("Array")]),r._v("<"),a("code",[r._v("any")]),r._v(">")])]),r._v(" "),a("tr",[a("td",[a("code",[r._v("Optional")]),r._v(" b")]),r._v(" "),a("td",[a("code",[r._v("any")])])])])]),r._v(" "),a("p",[a("strong",[r._v("Returns:")]),r._v(" "),a("code",[r._v("boolean")])]),r._v(" "),a("hr")])},[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/349.beab680d.js b/docs/assets/js/349.beab680d.js deleted file mode 100644 index 5ec8815811..0000000000 --- a/docs/assets/js/349.beab680d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[349],{606:function(t,e,a){"use strict";a.r(e);var o=a(46),r=Object(o.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"comparemap"}})]),t._v(" "),a("h2",{attrs:{id:"comparemap"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#comparemap","aria-hidden":"true"}},[t._v("#")]),t._v(" compareMap")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("compareMap")]),t._v("(a: "),a("em",[a("code",[t._v("Map")]),t._v("<"),a("code",[t._v("any")]),t._v(", "),a("code",[t._v("any")]),t._v(">")]),t._v(", b?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/utils/compareMap.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/utils/compareMap.ts:9"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("a")]),t._v(" "),a("td",[a("code",[t._v("Map")]),t._v("<"),a("code",[t._v("any")]),t._v(", "),a("code",[t._v("any")]),t._v(">")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" b")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/35.7026463c.js b/docs/assets/js/35.7026463c.js deleted file mode 100644 index 986882fccb..0000000000 --- a/docs/assets/js/35.7026463c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{373:function(t,e,n){"use strict";n.r(e);var r=n(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"functions"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),n("p",[n("a",{attrs:{id:"eralength"}})]),t._v(" "),n("h2",{attrs:{id:"eralength"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#eralength","aria-hidden":"true"}},[t._v("#")]),t._v(" eraLength")]),t._v(" "),n("p",[t._v("▸ "),n("strong",[t._v("eraLength")]),t._v("(api: "),n("em",[n("code",[t._v("ApiInterface$Rx")])]),t._v("): "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("p",[n("em",[t._v("Defined in "),n("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/session/eraLength.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("session/eraLength.ts:13"),n("OutboundLink")],1)])]),t._v(" "),n("p",[n("strong",[t._v("Parameters:")])]),t._v(" "),n("table",[n("thead",[n("tr",[n("th",[t._v("Name")]),t._v(" "),n("th",[t._v("Type")])])]),t._v(" "),n("tbody",[n("tr",[n("td",[t._v("api")]),t._v(" "),n("td",[n("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),n("p",[n("strong",[t._v("Returns:")]),t._v(" "),n("code",[t._v("(Anonymous function)")])]),t._v(" "),n("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/350.dd8e26c9.js b/docs/assets/js/350.dd8e26c9.js deleted file mode 100644 index 800b447e34..0000000000 --- a/docs/assets/js/350.dd8e26c9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[350],{608:function(t,e,r){"use strict";r.r(e);var a=r(46),o=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"functions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),r("p",[r("a",{attrs:{id:"decodeu8a"}})]),t._v(" "),r("h2",{attrs:{id:"decodeu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#decodeu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" decodeU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeU8a")]),t._v("(u8a: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", _types: "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("[] | "),r("code",[t._v("object")])],1),t._v("): "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("[]")],1),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/utils/decodeU8a.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("codec/utils/decodeU8a.ts:14"),r("OutboundLink")],1)])]),t._v(" "),r("p",[t._v("Given an u8a, and an array of Type constructors, decode the u8a against the types, and return an array of decoded values.")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("u8a")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])]),t._v(" "),r("td",[t._v("The u8a to decode.")])]),t._v(" "),r("tr",[r("td",[t._v("_types")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v("[] | "),r("code",[t._v("object")])],1),t._v(" "),r("td")])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v("[]")],1),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/351.d5d29456.js b/docs/assets/js/351.d5d29456.js deleted file mode 100644 index b7e43d254f..0000000000 --- a/docs/assets/js/351.d5d29456.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[351],{609:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_codec_vector_.vector.html"}},[t._v("Vector")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/352.4ca1680f.js b/docs/assets/js/352.4ca1680f.js deleted file mode 100644 index 342d0bedba..0000000000 --- a/docs/assets/js/352.4ca1680f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[352],{611:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/353.a00d14f4.js b/docs/assets/js/353.a00d14f4.js deleted file mode 100644 index 9ac5c52c01..0000000000 --- a/docs/assets/js/353.a00d14f4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[353],{612:function(a,t,e){"use strict";e.r(t);var r=e(46),s=Object(r.a)({},function(){var a=this,t=a.$createElement,e=a._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[a._v("#")]),a._v(" Index")]),a._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[a._v("#")]),a._v(" Classes")]),a._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_magicnumber_.magicnumber.html"}},[a._v("MagicNumber")])],1)]),a._v(" "),e("h3",{attrs:{id:"variables"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[a._v("#")]),a._v(" Variables")]),a._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/modules/_metadata_magicnumber_.html#magic_error"}},[a._v("MAGIC_ERROR")])],1),a._v(" "),e("li",[e("router-link",{attrs:{to:"/types/modules/_metadata_magicnumber_.html#magic_number"}},[a._v("MAGIC_NUMBER")])],1)]),a._v(" "),e("hr"),a._v(" "),e("h1",{attrs:{id:"variables-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#variables-2","aria-hidden":"true"}},[a._v("#")]),a._v(" Variables")]),a._v(" "),e("p",[e("a",{attrs:{id:"magic_error"}})]),a._v(" "),e("h2",{attrs:{id:"const-magic-error"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#const-magic-error","aria-hidden":"true"}},[a._v("#")]),a._v(" "),e("code",[a._v("")]),a._v(" MAGIC_ERROR")]),a._v(" "),e("p",[e("strong",[a._v("● MAGIC_ERROR")]),a._v(": "),e("em",[e("code",[a._v("-61746")])]),a._v(" = -61746")]),a._v(" "),e("p",[e("em",[a._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MagicNumber.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[a._v("Metadata/MagicNumber.ts:9"),e("OutboundLink")],1)])]),a._v(" "),e("hr"),a._v(" "),e("p",[e("a",{attrs:{id:"magic_number"}})]),a._v(" "),e("h2",{attrs:{id:"const-magic-number"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#const-magic-number","aria-hidden":"true"}},[a._v("#")]),a._v(" "),e("code",[a._v("")]),a._v(" MAGIC_NUMBER")]),a._v(" "),e("p",[e("strong",[a._v("● MAGIC_NUMBER")]),a._v(": "),e("em",[e("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[a._v("U32")])],1),a._v(" = new U32(0x6174656d)")]),a._v(" "),e("p",[e("em",[a._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MagicNumber.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[a._v("Metadata/MagicNumber.ts:8"),e("OutboundLink")],1)])]),a._v(" "),e("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/354.f8abebf6.js b/docs/assets/js/354.f8abebf6.js deleted file mode 100644 index a66f09c34c..0000000000 --- a/docs/assets/js/354.f8abebf6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[354],{614:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_metadata_.metadata.html"}},[t._v("Metadata")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/355.7bf4ffd3.js b/docs/assets/js/355.7bf4ffd3.js deleted file mode 100644 index 210c3f8157..0000000000 --- a/docs/assets/js/355.7bf4ffd3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[355],{617:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_metadata_metadataversioned_.metadataversioned.html"}},[t._v("MetadataVersioned")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/356.8c59d551.js b/docs/assets/js/356.8c59d551.js deleted file mode 100644 index 3d5647197f..0000000000 --- a/docs/assets/js/356.8c59d551.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[356],{615:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/357.8b269634.js b/docs/assets/js/357.8b269634.js deleted file mode 100644 index 11a7d643cf..0000000000 --- a/docs/assets/js/357.8b269634.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[357],{620:function(t,e,a){"use strict";a.r(e);var r=a(46),n=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/interfaces/_metadata_types_.metadatainterface.html"}},[t._v("MetadataInterface")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/358.0d9fae89.js b/docs/assets/js/358.0d9fae89.js deleted file mode 100644 index f0d1e0b704..0000000000 --- a/docs/assets/js/358.0d9fae89.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[358],{618:function(t,e,a){"use strict";a.r(e);var n=a(46),r=Object(n.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"flattenuniq"}})]),t._v(" "),a("h2",{attrs:{id:"flattenuniq"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#flattenuniq","aria-hidden":"true"}},[t._v("#")]),t._v(" flattenUniq")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("flattenUniq")]),t._v("(list: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v("): "),a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/util/flattenUniq.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/util/flattenUniq.ts:6"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("list")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/359.1864fd51.js b/docs/assets/js/359.1864fd51.js deleted file mode 100644 index 1c45cf3ab1..0000000000 --- a/docs/assets/js/359.1864fd51.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[359],{621:function(t,e,a){"use strict";a.r(e);var r=a(46),v=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"validatetypes"}})]),t._v(" "),a("h2",{attrs:{id:"validatetypes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#validatetypes","aria-hidden":"true"}},[t._v("#")]),t._v(" validateTypes")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("validateTypes")]),t._v("(types: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("string")]),t._v(">")]),t._v(", throwError: "),a("em",[a("code",[t._v("boolean")])]),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/util/validateTypes.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/util/validateTypes.ts:10"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("types")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("string")]),t._v(">")])]),t._v(" "),a("tr",[a("td",[t._v("throwError")]),t._v(" "),a("td",[a("code",[t._v("boolean")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/36.83308d7e.js b/docs/assets/js/36.83308d7e.js deleted file mode 100644 index 80c5442ba6..0000000000 --- a/docs/assets/js/36.83308d7e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{375:function(e,r,t){"use strict";t.r(r);var s=t(46),a=Object(s.a)({},function(){var e=this,r=e.$createElement,t=e._self._c||r;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),t("p",[t("a",{attrs:{id:"eraprogress"}})]),e._v(" "),t("h2",{attrs:{id:"eraprogress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#eraprogress","aria-hidden":"true"}},[e._v("#")]),e._v(" eraProgress")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("eraProgress")]),e._v("(api: "),t("em",[t("code",[e._v("ApiInterface$Rx")])]),e._v("): "),t("code",[e._v("(Anonymous function)")])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/session/eraProgress.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("session/eraProgress.ts:14"),t("OutboundLink")],1)])]),e._v(" "),t("p",[t("strong",[e._v("Parameters:")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("api")]),e._v(" "),t("td",[t("code",[e._v("ApiInterface$Rx")])])])])]),e._v(" "),t("p",[t("strong",[e._v("Returns:")]),e._v(" "),t("code",[e._v("(Anonymous function)")])]),e._v(" "),t("hr")])},[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/360.995c1f87.js b/docs/assets/js/360.995c1f87.js deleted file mode 100644 index e3e7750a7f..0000000000 --- a/docs/assets/js/360.995c1f87.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[360],{623:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchcall.html"}},[t._v("OuterDispatchCall")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html"}},[t._v("OuterDispatchMetadata")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/361.07f86df7.js b/docs/assets/js/361.07f86df7.js deleted file mode 100644 index 0ef65019f7..0000000000 --- a/docs/assets/js/361.07f86df7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[361],{626:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.eventmetadata.html"}},[t._v("EventMetadata")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadata.html"}},[t._v("OuterEventMetadata")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_metadata_v0_events_.outereventmetadataevent.html"}},[t._v("OuterEventMetadataEvent")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/362.2377269e.js b/docs/assets/js/362.2377269e.js deleted file mode 100644 index 161f7a79f3..0000000000 --- a/docs/assets/js/362.2377269e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[362],{624:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/363.a7e04d3f.js b/docs/assets/js/363.a7e04d3f.js deleted file mode 100644 index fda8efcf37..0000000000 --- a/docs/assets/js/363.a7e04d3f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[363],{627:function(t,a,e){"use strict";e.r(a);var s=e(46),l=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.callmetadata.html"}},[t._v("CallMetadata")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionargumentmetadata.html"}},[t._v("FunctionArgumentMetadata")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.functionmetadata.html"}},[t._v("FunctionMetadata")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.modulemetadata.html"}},[t._v("ModuleMetadata")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html"}},[t._v("RuntimeModuleMetadata")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html"}},[t._v("StorageFunctionMetadata")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html"}},[t._v("StorageFunctionModifier")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagefunctiontype.html"}},[t._v("StorageFunctionType")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v0_modules_.storagemetadata.html"}},[t._v("StorageMetadata")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/364.3a087e99.js b/docs/assets/js/364.3a087e99.js deleted file mode 100644 index 0464c83c50..0000000000 --- a/docs/assets/js/364.3a087e99.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[364],{629:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/365.7e7081ca.js b/docs/assets/js/365.7e7081ca.js deleted file mode 100644 index af4144d199..0000000000 --- a/docs/assets/js/365.7e7081ca.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[365],{630:function(a,t,e){"use strict";e.r(t);var s=e(46),l=Object(s.a)({},function(){var a=this,t=a.$createElement,e=a._self._c||t;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[a._v("#")]),a._v(" Index")]),a._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[a._v("#")]),a._v(" Classes")]),a._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacall.html"}},[a._v("MetadataCall")])],1),a._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_calls_.metadatacallarg.html"}},[a._v("MetadataCallArg")])],1)]),a._v(" "),e("hr")])},[],!1,null,null,null);t.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/366.d6ed06a5.js b/docs/assets/js/366.d6ed06a5.js deleted file mode 100644 index 7d3444d777..0000000000 --- a/docs/assets/js/366.d6ed06a5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[366],{632:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_metadata_v1_events_.metadataevent.html"}},[t._v("MetadataEvent")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/367.1ed3b875.js b/docs/assets/js/367.1ed3b875.js deleted file mode 100644 index 75cef5c23c..0000000000 --- a/docs/assets/js/367.1ed3b875.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[367],{633:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatamodule.html"}},[t._v("MetadataModule")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/368.2726ec3d.js b/docs/assets/js/368.2726ec3d.js deleted file mode 100644 index c6545dfc24..0000000000 --- a/docs/assets/js/368.2726ec3d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[368],{635:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/369.be7a251d.js b/docs/assets/js/369.be7a251d.js deleted file mode 100644 index f449497470..0000000000 --- a/docs/assets/js/369.be7a251d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[369],{636:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.default.html"}},[t._v("Default")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.maptype.html"}},[t._v("MapType")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastorage.html"}},[t._v("MetadataStorage")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html"}},[t._v("MetadataStorageModifier")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.metadatastoragetype.html"}},[t._v("MetadataStorageType")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.optional.html"}},[t._v("Optional")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_storage_.plaintype.html"}},[t._v("PlainType")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/37.1b12964f.js b/docs/assets/js/37.1b12964f.js deleted file mode 100644 index 13c1dae205..0000000000 --- a/docs/assets/js/37.1b12964f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{376:function(s,e,t){"use strict";t.r(e);var r=t(46),n=Object(r.a)({},function(){var s=this,e=s.$createElement,t=s._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[t("h1",{attrs:{id:"functions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[s._v("#")]),s._v(" Functions")]),s._v(" "),t("p",[t("a",{attrs:{id:"sessionprogress"}})]),s._v(" "),t("h2",{attrs:{id:"sessionprogress"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sessionprogress","aria-hidden":"true"}},[s._v("#")]),s._v(" sessionProgress")]),s._v(" "),t("p",[s._v("▸ "),t("strong",[s._v("sessionProgress")]),s._v("(api: "),t("em",[t("code",[s._v("ApiInterface$Rx")])]),s._v("): "),t("code",[s._v("(Anonymous function)")])]),s._v(" "),t("p",[t("em",[s._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/session/sessionProgress.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[s._v("session/sessionProgress.ts:14"),t("OutboundLink")],1)])]),s._v(" "),t("p",[t("strong",[s._v("Parameters:")])]),s._v(" "),t("table",[t("thead",[t("tr",[t("th",[s._v("Name")]),s._v(" "),t("th",[s._v("Type")])])]),s._v(" "),t("tbody",[t("tr",[t("td",[s._v("api")]),s._v(" "),t("td",[t("code",[s._v("ApiInterface$Rx")])])])])]),s._v(" "),t("p",[t("strong",[s._v("Returns:")]),s._v(" "),t("code",[s._v("(Anonymous function)")])]),s._v(" "),t("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/370.d728c50e.js b/docs/assets/js/370.d728c50e.js deleted file mode 100644 index 5d2feff970..0000000000 --- a/docs/assets/js/370.d728c50e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[370],{638:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"tov0"}})]),t._v(" "),e("h2",{attrs:{id:"tov0"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tov0","aria-hidden":"true"}},[t._v("#")]),t._v(" toV0")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("toV0")]),t._v("(v1: "),e("em",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1),t._v("): "),e("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/toV0.ts#L96",target:"_blank",rel:"noopener noreferrer"}},[t._v("Metadata/v1/toV0.ts:96"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("v1")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/types/classes/_metadata_v1_metadata_.metadatav1.html"}},[t._v("MetadataV1")])],1)])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/types/classes/_metadata_v0_metadata_.metadatav0.html"}},[t._v("MetadataV0")])],1),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/371.1221fd08.js b/docs/assets/js/371.1221fd08.js deleted file mode 100644 index 41e2f38f57..0000000000 --- a/docs/assets/js/371.1221fd08.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[371],{639:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_bool_.bool.html"}},[t._v("Bool")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/372.ed7d2826.js b/docs/assets/js/372.ed7d2826.js deleted file mode 100644 index 4cd58d8d4e..0000000000 --- a/docs/assets/js/372.ed7d2826.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[372],{641:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_bytes_.bytes.html"}},[t._v("Bytes")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/373.3a75111b.js b/docs/assets/js/373.3a75111b.js deleted file mode 100644 index ca62656b75..0000000000 --- a/docs/assets/js/373.3a75111b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[373],{642:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_data_.data.html"}},[t._v("Data")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/374.e62cbb4c.js b/docs/assets/js/374.e62cbb4c.js deleted file mode 100644 index 89127a2501..0000000000 --- a/docs/assets/js/374.e62cbb4c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[374],{692:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_h160_.h160.html"}},[t._v("H160")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/375.91881f5b.js b/docs/assets/js/375.91881f5b.js deleted file mode 100644 index 16f6c24e62..0000000000 --- a/docs/assets/js/375.91881f5b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[375],{644:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_h256_.h256.html"}},[t._v("H256")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/376.1db690d5.js b/docs/assets/js/376.1db690d5.js deleted file mode 100644 index 1c67cbeafd..0000000000 --- a/docs/assets/js/376.1db690d5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[376],{645:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_h512_.h512.html"}},[t._v("H512")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/377.de5d9945.js b/docs/assets/js/377.de5d9945.js deleted file mode 100644 index 763343e438..0000000000 --- a/docs/assets/js/377.de5d9945.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[377],{647:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_i128_.i128.html"}},[t._v("I128")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/378.66e8da8f.js b/docs/assets/js/378.66e8da8f.js deleted file mode 100644 index 8a6c3861a9..0000000000 --- a/docs/assets/js/378.66e8da8f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[378],{648:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_i16_.i16.html"}},[t._v("I16")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/379.a33060cc.js b/docs/assets/js/379.a33060cc.js deleted file mode 100644 index bd7f5aa409..0000000000 --- a/docs/assets/js/379.a33060cc.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[379],{650:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_i256_.i256.html"}},[t._v("I256")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/38.6e2028aa.js b/docs/assets/js/38.6e2028aa.js deleted file mode 100644 index 55e230d402..0000000000 --- a/docs/assets/js/38.6e2028aa.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{378:function(t,n,e){"use strict";e.r(n);var a=e(46),s=Object(a.a)({},function(){var t=this,n=t.$createElement,e=t._self._c||n;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"functions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),e("p",[e("a",{attrs:{id:"intentionsbalances"}})]),t._v(" "),e("h2",{attrs:{id:"intentionsbalances"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#intentionsbalances","aria-hidden":"true"}},[t._v("#")]),t._v(" intentionsBalances")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("intentionsBalances")]),t._v("(api: "),e("em",[e("code",[t._v("ApiInterface$Rx")])]),t._v("): "),e("code",[t._v("(Anonymous function)")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/staking/intentionsBalances.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("staking/intentionsBalances.ts:17"),e("OutboundLink")],1)])]),t._v(" "),e("p",[t._v("Get the balances for all intentions and their nominators")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("api")]),t._v(" "),e("td",[e("code",[t._v("ApiInterface$Rx")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("(Anonymous function)")])]),t._v(" "),e("hr")])},[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/380.b99b07cb.js b/docs/assets/js/380.b99b07cb.js deleted file mode 100644 index 474db2dc11..0000000000 --- a/docs/assets/js/380.b99b07cb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[380],{651:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_i32_.i32.html"}},[t._v("I32")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/381.ecdccf3b.js b/docs/assets/js/381.ecdccf3b.js deleted file mode 100644 index 40897f11ab..0000000000 --- a/docs/assets/js/381.ecdccf3b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[381],{653:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_i64_.i64.html"}},[t._v("I64")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/382.74ce6934.js b/docs/assets/js/382.74ce6934.js deleted file mode 100644 index 0880222a41..0000000000 --- a/docs/assets/js/382.74ce6934.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[382],{654:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_i8_.i8.html"}},[t._v("I8")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/383.b2df99e3.js b/docs/assets/js/383.b2df99e3.js deleted file mode 100644 index 7b24f265d7..0000000000 --- a/docs/assets/js/383.b2df99e3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[383],{656:function(t,e,s){"use strict";s.r(e);var r=s(46),i=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.method.html"}},[t._v("Method")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_method_.methodindex.html"}},[t._v("MethodIndex")])],1)]),t._v(" "),s("h3",{attrs:{id:"interfaces"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methodfunction.html"}},[t._v("MethodFunction")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.methods.html"}},[t._v("Methods")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/interfaces/_primitive_method_.moduleswithmethods.html"}},[t._v("ModulesWithMethods")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/384.3340f275.js b/docs/assets/js/384.3340f275.js deleted file mode 100644 index fbaf70890f..0000000000 --- a/docs/assets/js/384.3340f275.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[384],{657:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.moment.html"}},[t._v("Moment")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_moment_.momentof.html"}},[t._v("MomentOf")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/385.d812add9.js b/docs/assets/js/385.d812add9.js deleted file mode 100644 index 86826e4ab5..0000000000 --- a/docs/assets/js/385.d812add9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[385],{659:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_null_.null.html"}},[t._v("Null")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/386.88818459.js b/docs/assets/js/386.88818459.js deleted file mode 100644 index 88c2e9c3e9..0000000000 --- a/docs/assets/js/386.88818459.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[386],{660:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_storagedata_.storagedata.html"}},[t._v("StorageData")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/387.6ca2ea8e.js b/docs/assets/js/387.6ca2ea8e.js deleted file mode 100644 index 4827753f4e..0000000000 --- a/docs/assets/js/387.6ca2ea8e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[387],{662:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_primitive_storagekey_.storagekey.html"}},[t._v("StorageKey")])],1)]),t._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/interfaces/_primitive_storagekey_.storagefunction.html"}},[t._v("StorageFunction")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/388.2a85b4d3.js b/docs/assets/js/388.2a85b4d3.js deleted file mode 100644 index 4c7d093657..0000000000 --- a/docs/assets/js/388.2a85b4d3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[388],{663:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_text_.text.html"}},[t._v("Text")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/389.32e60d49.js b/docs/assets/js/389.32e60d49.js deleted file mode 100644 index 2f753bb422..0000000000 --- a/docs/assets/js/389.32e60d49.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[389],{665:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_type_.type.html"}},[t._v("Type")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/39.2ef37369.js b/docs/assets/js/39.2ef37369.js deleted file mode 100644 index 21dcc866ef..0000000000 --- a/docs/assets/js/39.2ef37369.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{379:function(e,a,t){"use strict";t.r(a);var r=t(46),s=Object(r.a)({},function(){var e=this,a=e.$createElement,t=e._self._c||a;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"type-aliases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("p",[t("a",{attrs:{id:"derivedbalances"}})]),e._v(" "),t("h2",{attrs:{id:"derivedbalances"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#derivedbalances","aria-hidden":"true"}},[e._v("#")]),e._v(" DerivedBalances")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ DerivedBalances")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:8"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"derivedbalancesmap"}})]),e._v(" "),t("h2",{attrs:{id:"derivedbalancesmap"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#derivedbalancesmap","aria-hidden":"true"}},[e._v("#")]),e._v(" DerivedBalancesMap")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ DerivedBalancesMap")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:26"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"derivedfees"}})]),e._v(" "),t("h2",{attrs:{id:"derivedfees"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#derivedfees","aria-hidden":"true"}},[e._v("#")]),e._v(" DerivedFees")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ DerivedFees")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:18"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr"),e._v(" "),t("p",[t("a",{attrs:{id:"derivedreferendumvote"}})]),e._v(" "),t("h2",{attrs:{id:"derivedreferendumvote"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#derivedreferendumvote","aria-hidden":"true"}},[e._v("#")]),e._v(" DerivedReferendumVote")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ DerivedReferendumVote")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/types.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:30"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/390.bf318495.js b/docs/assets/js/390.bf318495.js deleted file mode 100644 index f2b1acda64..0000000000 --- a/docs/assets/js/390.bf318495.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[390],{666:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_u128_.u128.html"}},[t._v("U128")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/391.93d6b009.js b/docs/assets/js/391.93d6b009.js deleted file mode 100644 index 9b1bf95a60..0000000000 --- a/docs/assets/js/391.93d6b009.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[391],{668:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_u16_.u16.html"}},[t._v("U16")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/392.5b3ed9eb.js b/docs/assets/js/392.5b3ed9eb.js deleted file mode 100644 index dcfeb6ae40..0000000000 --- a/docs/assets/js/392.5b3ed9eb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[392],{669:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_u256_.u256.html"}},[t._v("U256")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/393.129cca6c.js b/docs/assets/js/393.129cca6c.js deleted file mode 100644 index 9beb95a489..0000000000 --- a/docs/assets/js/393.129cca6c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[393],{671:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_u32_.u32.html"}},[t._v("U32")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/394.e51c5ace.js b/docs/assets/js/394.e51c5ace.js deleted file mode 100644 index 5724d50c81..0000000000 --- a/docs/assets/js/394.e51c5ace.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[394],{672:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_u64_.u64.html"}},[t._v("U64")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/395.f2f04b18.js b/docs/assets/js/395.f2f04b18.js deleted file mode 100644 index edd0429a22..0000000000 --- a/docs/assets/js/395.f2f04b18.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[395],{674:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_primitive_u8_.u8.html"}},[t._v("U8")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/396.1fd42ede.js b/docs/assets/js/396.1fd42ede.js deleted file mode 100644 index 81acdc5984..0000000000 --- a/docs/assets/js/396.1fd42ede.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[396],{675:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_primitive_usize_.usize.html"}},[t._v("USize")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/397.c1813965.js b/docs/assets/js/397.c1813965.js deleted file mode 100644 index a8882db312..0000000000 --- a/docs/assets/js/397.c1813965.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[397],{677:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_chainproperties_.chainproperties.html"}},[t._v("ChainProperties")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/398.32eb13aa.js b/docs/assets/js/398.32eb13aa.js deleted file mode 100644 index f426661df1..0000000000 --- a/docs/assets/js/398.32eb13aa.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[398],{678:function(t,s,r){"use strict";r.r(s);var e=r(46),a=Object(e.a)({},function(){var t=this,s=t.$createElement,r=t._self._c||s;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"classes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.broadcast.html"}},[t._v("Broadcast")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.dropped.html"}},[t._v("Dropped")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html"}},[t._v("ExtrinsicStatus")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.finalised.html"}},[t._v("Finalised")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.future.html"}},[t._v("Future")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.invalid.html"}},[t._v("Invalid")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.ready.html"}},[t._v("Ready")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_rpc_extrinsicstatus_.usurped.html"}},[t._v("Usurped")])],1)]),t._v(" "),r("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/399.795446a3.js b/docs/assets/js/399.795446a3.js deleted file mode 100644 index d20ac2aa83..0000000000 --- a/docs/assets/js/399.795446a3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[399],{680:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_health_.health.html"}},[t._v("Health")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/4.adbf2d29.js b/docs/assets/js/4.adbf2d29.js deleted file mode 100644 index 627945660a..0000000000 --- a/docs/assets/js/4.adbf2d29.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[4],{250:function(t,e,s){},269:function(t,e,s){"use strict";var n=s(250);s.n(n).a},301:function(t,e,s){"use strict";s.r(e);var n=["There's nothing here.","How did we get here?","That's a Four-Oh-Four.","Looks like we've got some broken links."],o={methods:{getMsg:function(){return n[Math.floor(Math.random()*n.length)]}}},i=(s(269),s(46)),r=Object(i.a)(o,function(){var t=this.$createElement,e=this._self._c||t;return e("div",{staticClass:"theme-container"},[e("div",{staticClass:"content"},[e("h1",[this._v("404")]),this._v(" "),e("blockquote",[this._v(this._s(this.getMsg()))]),this._v(" "),e("router-link",{attrs:{to:"/"}},[this._v("Take me home.")])],1)])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/40.49c833ce.js b/docs/assets/js/40.49c833ce.js deleted file mode 100644 index 4114599c2f..0000000000 --- a/docs/assets/js/40.49c833ce.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{381:function(t,e,a){"use strict";a.r(e);var v=a(46),n=Object(v.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"cache"}})]),t._v(" "),a("h2",{attrs:{id:"const-cache"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-cache","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" cache")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("cache")]),t._v("(fn: "),a("em",[a("code",[t._v("Function")])]),t._v(", map?: "),a("em",[a("code",[t._v("WeakMap")]),t._v("<"),a("code",[t._v("object")]),t._v(", "),a("code",[t._v("any")]),t._v(">")]),t._v("): "),a("code",[t._v("(Anonymous function)")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api-derive/src/util/cache.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("util/cache.ts:23"),a("OutboundLink")],1)])]),t._v(" "),a("p",[t._v("Create memoization for a 2-currified function.")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("fn")]),t._v(" "),a("td",[a("code",[t._v("Function")])]),t._v(" "),a("td",[t._v("-")]),t._v(" "),a("td",[t._v("The function to memoize.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" map")]),t._v(" "),a("td",[a("code",[t._v("WeakMap")]),t._v("<"),a("code",[t._v("object")]),t._v(", "),a("code",[t._v("any")]),t._v(">")]),t._v(" "),a("td",[t._v("new WeakMap()")]),t._v(" "),a("td",[t._v("The Map used to cache function returns.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("(Anonymous function)")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/400.f6ece95d.js b/docs/assets/js/400.f6ece95d.js deleted file mode 100644 index f8a9102bea..0000000000 --- a/docs/assets/js/400.f6ece95d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[400],{681:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_rpc_json_.json.html"}},[t._v("Json")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/401.0002d8cf.js b/docs/assets/js/401.0002d8cf.js deleted file mode 100644 index d532cee64e..0000000000 --- a/docs/assets/js/401.0002d8cf.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[401],{683:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_networkstate_.networkstate.html"}},[t._v("NetworkState")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/402.dd239bd6.js b/docs/assets/js/402.dd239bd6.js deleted file mode 100644 index 0cbff54112..0000000000 --- a/docs/assets/js/402.dd239bd6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[402],{684:function(e,t,s){"use strict";s.r(t);var r=s(46),a=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_peerinfo_.peerinfo.html"}},[e._v("PeerInfo")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/403.162a25a1.js b/docs/assets/js/403.162a25a1.js deleted file mode 100644 index 57c5367e6d..0000000000 --- a/docs/assets/js/403.162a25a1.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[403],{686:function(t,s,e){"use strict";e.r(s);var r=e(46),n=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html"}},[t._v("PendingExtrinsics")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/404.cd26d08b.js b/docs/assets/js/404.cd26d08b.js deleted file mode 100644 index 8c29dbe035..0000000000 --- a/docs/assets/js/404.cd26d08b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[404],{687:function(t,e,s){"use strict";s.r(e);var r=s(46),i=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.apiid.html"}},[t._v("ApiId")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversion.html"}},[t._v("RuntimeVersion")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_runtimeversion_.runtimeversionapi.html"}},[t._v("RuntimeVersionApi")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/405.41d2d800.js b/docs/assets/js/405.41d2d800.js deleted file mode 100644 index 85d6511b30..0000000000 --- a/docs/assets/js/405.41d2d800.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[405],{689:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_rpc_signedblock_.signedblock.html"}},[t._v("SignedBlock")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/406.b4c405ad.js b/docs/assets/js/406.b4c405ad.js deleted file mode 100644 index 530217b790..0000000000 --- a/docs/assets/js/406.b4c405ad.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[406],{690:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_rpc_storagechangeset_.storagechangeset.html"}},[t._v("StorageChangeSet")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/407.1482cae8.js b/docs/assets/js/407.1482cae8.js deleted file mode 100644 index b25fdc0f3a..0000000000 --- a/docs/assets/js/407.1482cae8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[407],{693:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/408.b826a189.js b/docs/assets/js/408.b826a189.js deleted file mode 100644 index 94412f138f..0000000000 --- a/docs/assets/js/408.b826a189.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[408],{695:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountid.html"}},[t._v("AccountId")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_type_accountid_.accountidof.html"}},[t._v("AccountIdOf")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/409.be518933.js b/docs/assets/js/409.be518933.js deleted file mode 100644 index cf7088b1d5..0000000000 --- a/docs/assets/js/409.be518933.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[409],{696:function(t,e,a){"use strict";a.r(e);var s=a(46),r=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_type_accountindex_.accountindex.html"}},[t._v("AccountIndex")])],1)]),t._v(" "),a("h3",{attrs:{id:"variables"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/modules/_type_accountindex_.html#enumset_size"}},[t._v("ENUMSET_SIZE")])],1)]),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"variables-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#variables-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),a("p",[a("a",{attrs:{id:"enumset_size"}})]),t._v(" "),a("h2",{attrs:{id:"const-enumset-size"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#const-enumset-size","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" ENUMSET_SIZE")]),t._v(" "),a("p",[a("strong",[t._v("● ENUMSET_SIZE")]),t._v(": "),a("em",[a("code",[t._v("BN")])]),t._v(" = new BN(64)")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/AccountIndex.ts:12"),a("OutboundLink")],1)])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/41.0e6ea377.js b/docs/assets/js/41.0e6ea377.js deleted file mode 100644 index 0a2ad9235d..0000000000 --- a/docs/assets/js/41.0e6ea377.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[41],{382:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/410.86fff13b.js b/docs/assets/js/410.86fff13b.js deleted file mode 100644 index 620d1eb3ab..0000000000 --- a/docs/assets/js/410.86fff13b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[410],{698:function(t,a,e){"use strict";e.r(a);var r=e(46),s=Object(r.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_address_.address.html"}},[t._v("Address")])],1)]),t._v(" "),e("h3",{attrs:{id:"variables"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/modules/_type_address_.html#account_id_prefix"}},[t._v("ACCOUNT_ID_PREFIX")])],1)]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"variables-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#variables-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),e("p",[e("a",{attrs:{id:"account_id_prefix"}})]),t._v(" "),e("h2",{attrs:{id:"const-account-id-prefix"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#const-account-id-prefix","aria-hidden":"true"}},[t._v("#")]),t._v(" "),e("code",[t._v("")]),t._v(" ACCOUNT_ID_PREFIX")]),t._v(" "),e("p",[e("strong",[t._v("● ACCOUNT_ID_PREFIX")]),t._v(": "),e("em",[e("code",[t._v("Uint8Array")])]),t._v(" = new Uint8Array([0xff])")]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Address.ts:16"),e("OutboundLink")],1)])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/411.6c670c0f.js b/docs/assets/js/411.6c670c0f.js deleted file mode 100644 index 6bae211a74..0000000000 --- a/docs/assets/js/411.6c670c0f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[411],{699:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_amount_.amount.html"}},[t._v("Amount")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/412.8092ef28.js b/docs/assets/js/412.8092ef28.js deleted file mode 100644 index db4a191d0f..0000000000 --- a/docs/assets/js/412.8092ef28.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[412],{701:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_assetof_.assetof.html"}},[t._v("AssetOf")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/413.19be8b54.js b/docs/assets/js/413.19be8b54.js deleted file mode 100644 index ca3c2f559c..0000000000 --- a/docs/assets/js/413.19be8b54.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[413],{702:function(t,e,a){"use strict";a.r(e);var s=a(46),i=Object(s.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.attestedcandidate.html"}},[t._v("AttestedCandidate")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.availabilityvote.html"}},[t._v("AvailabilityVote")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.balanceupload.html"}},[t._v("BalanceUpload")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatereceipt.html"}},[t._v("CandidateReceipt")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.candidatesignature.html"}},[t._v("CandidateSignature")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.egressqueueroot.html"}},[t._v("EgressQueueRoot")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html"}},[t._v("ExplicitCandidateSignature")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.headdata.html"}},[t._v("HeadData")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html"}},[t._v("ImplicitCandidateSignature")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityattestation.html"}},[t._v("ValidityAttestation")])],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_attestedcandidate_.validityvote.html"}},[t._v("ValidityVote")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/414.76493004.js b/docs/assets/js/414.76493004.js deleted file mode 100644 index dcf75c253f..0000000000 --- a/docs/assets/js/414.76493004.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[414],{704:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_authorityid_.authorityid.html"}},[t._v("AuthorityId")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/415.bdff2d2d.js b/docs/assets/js/415.bdff2d2d.js deleted file mode 100644 index 07e38e2b21..0000000000 --- a/docs/assets/js/415.bdff2d2d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[415],{705:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_balance_.balance.html"}},[t._v("Balance")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_type_balance_.balanceof.html"}},[t._v("BalanceOf")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/416.889eb219.js b/docs/assets/js/416.889eb219.js deleted file mode 100644 index 9ef7133ce9..0000000000 --- a/docs/assets/js/416.889eb219.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[416],{707:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_bft_.bftauthoritysignature.html"}},[t._v("BftAuthoritySignature")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_type_bft_.bfthashsignature.html"}},[t._v("BftHashSignature")])],1)]),t._v(" "),e("h3",{attrs:{id:"type-aliases"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/modules/_type_bft_.html#bftauthoritysignaturevalue"}},[t._v("BftAuthoritySignatureValue")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/modules/_type_bft_.html#bfthashsignaturevalue"}},[t._v("BftHashSignatureValue")])],1)]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"type-aliases-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),e("p",[e("a",{attrs:{id:"bftauthoritysignaturevalue"}})]),t._v(" "),e("h2",{attrs:{id:"bftauthoritysignaturevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bftauthoritysignaturevalue","aria-hidden":"true"}},[t._v("#")]),t._v(" BftAuthoritySignatureValue")]),t._v(" "),e("p",[e("strong",[t._v("Ƭ BftAuthoritySignatureValue")]),t._v(": "),e("em",[t._v("["),e("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(", "),e("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v("]")],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Bft.ts:12"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"bfthashsignaturevalue"}})]),t._v(" "),e("h2",{attrs:{id:"bfthashsignaturevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bfthashsignaturevalue","aria-hidden":"true"}},[t._v("#")]),t._v(" BftHashSignatureValue")]),t._v(" "),e("p",[e("strong",[t._v("Ƭ BftHashSignatureValue")]),t._v(": "),e("em",[t._v("["),e("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v(", "),e("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")]),t._v("]")],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L43",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Bft.ts:43"),e("OutboundLink")],1)])]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/417.534b13ab.js b/docs/assets/js/417.534b13ab.js deleted file mode 100644 index 6efb6f878c..0000000000 --- a/docs/assets/js/417.534b13ab.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[417],{708:function(a,e,t){"use strict";t.r(e);var s=t(46),r=Object(s.a)({},function(){var a=this,e=a.$createElement,t=a._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[a._v("#")]),a._v(" Index")]),a._v(" "),t("h3",{attrs:{id:"classes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[a._v("#")]),a._v(" Classes")]),a._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/types/classes/_type_block_.block.html"}},[a._v("Block")])],1)]),a._v(" "),t("h3",{attrs:{id:"type-aliases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[a._v("#")]),a._v(" Type aliases")]),a._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/types/modules/_type_block_.html#blockvalue"}},[a._v("BlockValue")])],1)]),a._v(" "),t("hr"),a._v(" "),t("h1",{attrs:{id:"type-aliases-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[a._v("#")]),a._v(" Type aliases")]),a._v(" "),t("p",[t("a",{attrs:{id:"blockvalue"}})]),a._v(" "),t("h2",{attrs:{id:"blockvalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#blockvalue","aria-hidden":"true"}},[a._v("#")]),a._v(" BlockValue")]),a._v(" "),t("p",[t("strong",[a._v("Ƭ BlockValue")]),a._v(": "),t("em",[t("code",[a._v("object")])])]),a._v(" "),t("p",[t("em",[a._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[a._v("type/Block.ts:14"),t("OutboundLink")],1)])]),a._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[a._v("#")]),a._v(" Type declaration")]),a._v(" "),t("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/418.d43b51b8.js b/docs/assets/js/418.d43b51b8.js deleted file mode 100644 index 469c91ba3c..0000000000 --- a/docs/assets/js/418.d43b51b8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[418],{710:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_blocknumber_.blocknumber.html"}},[t._v("BlockNumber")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/419.e38eec68.js b/docs/assets/js/419.e38eec68.js deleted file mode 100644 index f43c23b861..0000000000 --- a/docs/assets/js/419.e38eec68.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[419],{711:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_codehash_.codehash.html"}},[t._v("CodeHash")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/42.8407b7c4.js b/docs/assets/js/42.8407b7c4.js deleted file mode 100644 index ced7f211bd..0000000000 --- a/docs/assets/js/42.8407b7c4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{384:function(t,a,s){"use strict";s.r(a);var n=s(46),e=Object(n.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"polkadot-api"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-api","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/api")]),t._v(" "),s("p",[t._v("The Polkadot-JS API provides easy-to-use wrappers around JSONRPC calls that flow from an application to a node. It handles all the encoding and decoding or parameters, provides access to RPC functions and allows for the query of chain state and the submission of transactions.")]),t._v(" "),s("p",[t._v("The API wrappers provide a standard interface for use -")]),t._v(" "),s("ul",[s("li",[t._v("A static "),s("code",[t._v(".create()")]),t._v(" that returns an API instance when connected, decorated and ready-to use. ApiOptions can include an optional WsProvider and optional custom type definitions "),s("code",[t._v("{ provider: , types: }")]),t._v(".")]),t._v(" "),s("li",[t._v("The above is just a wrapper for "),s("code",[t._v("new Api()")]),t._v(", exposing the "),s("code",[t._v("isReady")]),t._v(" getter")]),t._v(" "),s("li",[s("code",[t._v("api.rpc.
.")]),t._v(" provides access to actual RPC calls, be it for queries, submission or retrieving chain information\n"),s("ul",[s("li",[s("router-link",{attrs:{to:"/METHODS_RPC.html"}},[t._v("RPC (node interface)")])],1)])]),t._v(" "),s("li",[s("code",[t._v("api.query.
.")]),t._v(" provides access to chain state queries. These are dynamically populated based on what the runtime provides\n"),s("ul",[s("li",[s("router-link",{attrs:{to:"/METHODS_STORAGE.html"}},[t._v("Storage chain state (runtime node interface)")])],1)])]),t._v(" "),s("li",[s("code",[t._v("api.tx.
.")]),t._v(" provides the ability to create a transaction, like chain state, this list is populated from a runtime query\n"),s("ul",[s("li",[s("router-link",{attrs:{to:"/METHODS_EXTRINSICS.html"}},[t._v("Extrinsics (runtime node interface)")])],1)])])]),t._v(" "),s("h2",{attrs:{id:"api-selection"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#api-selection","aria-hidden":"true"}},[t._v("#")]),t._v(" API Selection")]),t._v(" "),s("p",[t._v("There are two flavours of the API provided, one allowing a standard interface via JavaScript Promises and the second provides an Observable wrapper using "),s("a",{attrs:{href:"https://github.com/ReactiveX/rxjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("RxJS"),s("OutboundLink")],1),t._v(". Depending on your use-case and familiarity, you can choose either (or even both) for your application.")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")]),t._v(" All interface calls returns Promises, including the static "),s("code",[t._v(".create(...)")]),t._v(". Additionally any subscription method uses "),s("code",[t._v("(value) => {}")]),t._v(" callbacks, returning the value as the subscription is updated.")],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(" All interface calls return RxJS Observables, including the static "),s("code",[t._v(".create(...)")]),t._v(". In the same fashion subscription-based methods return long-running Observables that update with the latest values.")],1)]),t._v(" "),s("h2",{attrs:{id:"dynamic-by-default"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dynamic-by-default","aria-hidden":"true"}},[t._v("#")]),t._v(" Dynamic by default")]),t._v(" "),s("p",[t._v("Substrate (upon which Polkadot is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.")]),t._v(" "),s("p",[t._v("Due to this dynamic nature, this API departs from traditional APIs which only has fixed endpoints, driving use by what is available by the runtime. As a start, this generic nature has a learning curve, although the provided documentation, examples and linked documentation tries to make that experience as seamless as possible.")]),t._v(" "),s("h2",{attrs:{id:"installation-import"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installation-import","aria-hidden":"true"}},[t._v("#")]),t._v(" Installation & import")]),t._v(" "),s("p",[t._v("Installation -")]),t._v(" "),s("div",{staticClass:"language- line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("npm install --save @polkadot/api\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br")])]),s("p",[t._v("Subscribing to blocks via Promise-based API -")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via static create")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// make a call to retrieve the current network head")]),t._v("\napi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at #")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br")])]),s("p",[t._v("Subscribing to blocks via RxJS-based API -")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via static create")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// make a call to retrieve the current network head")]),t._v("\napi"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at #")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br")])]),s("h2",{attrs:{id:"registering-custom-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#registering-custom-types","aria-hidden":"true"}},[t._v("#")]),t._v(" Registering custom types")]),t._v(" "),s("p",[t._v("Additional types used by runtime modules can be added when a new instance of the API is created. This is necessary if the runtime modules use types which are not available in the base Substrate runtime.")]),t._v(" "),s("div",{staticClass:"language-javascript line-numbers-mode"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via static create and register custom types")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n types"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n CustomTypesExample"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"u32"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"data"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Vec"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"deposit"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Balance"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"owner"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"AccountId"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"application_expiry"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Moment"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"whitelisted"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bool"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"challenge_id"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"u32"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),s("div",{staticClass:"line-numbers-wrapper"},[s("span",{staticClass:"line-number"},[t._v("1")]),s("br"),s("span",{staticClass:"line-number"},[t._v("2")]),s("br"),s("span",{staticClass:"line-number"},[t._v("3")]),s("br"),s("span",{staticClass:"line-number"},[t._v("4")]),s("br"),s("span",{staticClass:"line-number"},[t._v("5")]),s("br"),s("span",{staticClass:"line-number"},[t._v("6")]),s("br"),s("span",{staticClass:"line-number"},[t._v("7")]),s("br"),s("span",{staticClass:"line-number"},[t._v("8")]),s("br"),s("span",{staticClass:"line-number"},[t._v("9")]),s("br"),s("span",{staticClass:"line-number"},[t._v("10")]),s("br"),s("span",{staticClass:"line-number"},[t._v("11")]),s("br"),s("span",{staticClass:"line-number"},[t._v("12")]),s("br"),s("span",{staticClass:"line-number"},[t._v("13")]),s("br"),s("span",{staticClass:"line-number"},[t._v("14")]),s("br"),s("span",{staticClass:"line-number"},[t._v("15")]),s("br"),s("span",{staticClass:"line-number"},[t._v("16")]),s("br")])]),s("h2",{attrs:{id:"users"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#users","aria-hidden":"true"}},[t._v("#")]),t._v(" Users")]),t._v(" "),s("p",[t._v("Some of the users of the API (let us know if you are missing from the list), include -")]),t._v(" "),s("ul",[s("li",[s("a",{attrs:{href:"https://github.com/polkadot-js/apps",target:"_blank",rel:"noopener noreferrer"}},[t._v("Polkadot-JS UI"),s("OutboundLink")],1),t._v(" A user-interface that allows you to make transactions, query the network or participate in actions on the network such as referendums and staking")]),t._v(" "),s("li",[s("a",{attrs:{href:"https://gitlab.com/Polkabot",target:"_blank",rel:"noopener noreferrer"}},[t._v("Polkabot"),s("OutboundLink")],1),t._v(" Polkabot is a Matrix chatbot that keeps an eye on the Polkadot network. You can see Polkabot in action in "),s("a",{attrs:{href:"https://matrix.to/#/#polkadot-network-status:matrix.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://matrix.to/#/#polkadot-network-status:matrix.org"),s("OutboundLink")],1)]),t._v(" "),s("li",[s("a",{attrs:{href:"https://polkawallet.io",target:"_blank",rel:"noopener noreferrer"}},[t._v("Polkawallet.io"),s("OutboundLink")],1),t._v(" and "),s("a",{attrs:{href:"https://github.com/polkawallet-io/polkawallet-RN/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Polkawallet (Github)"),s("OutboundLink")],1),t._v(" A mobile wallet for the Polkadot network to manage funds and make transactions, available on both Androind and iOS")])]),t._v(" "),s("h2",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("p",[s("router-link",{attrs:{to:"/api/SUMMARY.html"}},[t._v("Classes")])],1)])},[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/420.bf13b289.js b/docs/assets/js/420.bf13b289.js deleted file mode 100644 index cb6f91c509..0000000000 --- a/docs/assets/js/420.bf13b289.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[420],{713:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.authoritieschange.html"}},[t._v("AuthoritiesChange")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.changestrieroot.html"}},[t._v("ChangesTrieRoot")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digest.html"}},[t._v("Digest")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.digestitem.html"}},[t._v("DigestItem")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.other.html"}},[t._v("Other")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_digest_.seal.html"}},[t._v("Seal")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/421.616046f6.js b/docs/assets/js/421.616046f6.js deleted file mode 100644 index 4faa33a9fa..0000000000 --- a/docs/assets/js/421.616046f6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[421],{714:function(t,e,s){"use strict";s.r(e);var a=s(46),n=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.event.html"}},[t._v("Event")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventdata.html"}},[t._v("EventData")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_event_.eventindex.html"}},[t._v("EventIndex")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/422.3933effc.js b/docs/assets/js/422.3933effc.js deleted file mode 100644 index 18e1d13e6f..0000000000 --- a/docs/assets/js/422.3933effc.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[422],{716:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.applyextrinsic.html"}},[t._v("ApplyExtrinsic")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.eventrecord.html"}},[t._v("EventRecord")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.finalization.html"}},[t._v("Finalization")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_eventrecord_.phase.html"}},[t._v("Phase")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/423.21e1d41f.js b/docs/assets/js/423.21e1d41f.js deleted file mode 100644 index fb742a02e5..0000000000 --- a/docs/assets/js/423.21e1d41f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[423],{717:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_extrinsic_.extrinsic.html"}},[t._v("Extrinsic")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/424.c7c086b6.js b/docs/assets/js/424.c7c086b6.js deleted file mode 100644 index b3e2d9597b..0000000000 --- a/docs/assets/js/424.c7c086b6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[424],{719:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_extrinsicera_.extrinsicera.html"}},[t._v("ExtrinsicEra")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/425.54913cd2.js b/docs/assets/js/425.54913cd2.js deleted file mode 100644 index d85f6df63b..0000000000 --- a/docs/assets/js/425.54913cd2.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[425],{720:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_extrinsics_.extrinsics.html"}},[t._v("Extrinsics")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/426.a7fed113.js b/docs/assets/js/426.a7fed113.js deleted file mode 100644 index 2c6de887ba..0000000000 --- a/docs/assets/js/426.a7fed113.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[426],{722:function(t,a,r){"use strict";r.r(a);var e=r(46),s=Object(e.a)({},function(){var t=this,a=t.$createElement,r=t._self._c||a;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"classes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/classes/_type_extrinsicsignature_.extrinsicsignature.html"}},[t._v("ExtrinsicSignature")])],1)]),t._v(" "),r("h3",{attrs:{id:"variables"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#variables","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/modules/_type_extrinsicsignature_.html#immortal_era"}},[t._v("IMMORTAL_ERA")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"variables-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#variables-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),r("p",[r("a",{attrs:{id:"immortal_era"}})]),t._v(" "),r("h2",{attrs:{id:"const-immortal-era"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#const-immortal-era","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" IMMORTAL_ERA")]),t._v(" "),r("p",[r("strong",[t._v("● IMMORTAL_ERA")]),t._v(": "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(" = new Uint8Array([0])")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/ExtrinsicSignature.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/427.7f371c22.js b/docs/assets/js/427.7f371c22.js deleted file mode 100644 index e45a1ed903..0000000000 --- a/docs/assets/js/427.7f371c22.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[427],{723:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_gas_.gas.html"}},[t._v("Gas")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/428.08745b54.js b/docs/assets/js/428.08745b54.js deleted file mode 100644 index 709a986c22..0000000000 --- a/docs/assets/js/428.08745b54.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[428],{725:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_hash_.hash.html"}},[t._v("Hash")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/429.d20bd9c7.js b/docs/assets/js/429.d20bd9c7.js deleted file mode 100644 index bd790ac001..0000000000 --- a/docs/assets/js/429.d20bd9c7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[429],{726:function(e,a,t){"use strict";t.r(a);var r=t(46),s=Object(r.a)({},function(){var e=this,a=e.$createElement,t=e._self._c||a;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),t("h3",{attrs:{id:"classes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/types/classes/_type_header_.header.html"}},[e._v("Header")])],1),e._v(" "),t("li",[t("router-link",{attrs:{to:"/types/classes/_type_header_.headerextended.html"}},[e._v("HeaderExtended")])],1)]),e._v(" "),t("h3",{attrs:{id:"type-aliases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/types/modules/_type_header_.html#headervalue"}},[e._v("HeaderValue")])],1)]),e._v(" "),t("hr"),e._v(" "),t("h1",{attrs:{id:"type-aliases-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),t("p",[t("a",{attrs:{id:"headervalue"}})]),e._v(" "),t("h2",{attrs:{id:"headervalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#headervalue","aria-hidden":"true"}},[e._v("#")]),e._v(" HeaderValue")]),e._v(" "),t("p",[t("strong",[e._v("Ƭ HeaderValue")]),e._v(": "),t("em",[t("code",[e._v("object")])])]),e._v(" "),t("p",[t("em",[e._v("Defined in "),t("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/Header.ts:17"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"type-declaration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),t("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/43.5f2da7c0.js b/docs/assets/js/43.5f2da7c0.js deleted file mode 100644 index c96c3d9bff..0000000000 --- a/docs/assets/js/43.5f2da7c0.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{385:function(t,e,i){"use strict";i.r(e);var r=i(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,i=t._self._c||e;return i("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[i("ul",[i("li",[i("router-link",{attrs:{to:"/api/modules/_base_.html"}},[t._v('"Base"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_submittableextrinsic_.html"}},[t._v('"SubmittableExtrinsic"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableresult.html"}},[t._v("SubmittableResult")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_checktypes_manual_.html"}},[t._v('"checkTypes.manual"')])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_promise_api_.html"}},[t._v('"promise/Api"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html"}},[t._v('"promise/Combinator"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/classes/_promise_combinator_.combinator.html"}},[t._v("Combinator")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_promise_types_.html"}},[t._v('"promise/types"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_rx_api_.html"}},[t._v('"rx/Api"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_rx_types_.html"}},[t._v('"rx/types"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_types_.html"}},[t._v('"types"')]),t._v(" "),i("ul",[i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.apiinterface_decorated.html"}},[t._v("ApiInterface$Decorated")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_method.html"}},[t._v("DecoratedRpc$Method")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_section.html"}},[t._v("DecoratedRpc$Section")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.derivemethodbase.html"}},[t._v("DeriveMethodBase")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.derivesection.html"}},[t._v("DeriveSection")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.queryablemodulestorage.html"}},[t._v("QueryableModuleStorage")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestoragefunctionbase.html"}},[t._v("QueryableStorageFunctionBase")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsicfunction.html"}},[t._v("SubmittableExtrinsicFunction")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/interfaces/_types_.submittablemoduleextrinsics.html"}},[t._v("SubmittableModuleExtrinsics")])],1)])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_util_filterevents_.html"}},[t._v('"util/filterEvents"')])],1),t._v(" "),i("li",[i("router-link",{attrs:{to:"/api/modules/_util_logging_.html"}},[t._v('"util/logging"')])],1)])])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/430.f2cbef53.js b/docs/assets/js/430.f2cbef53.js deleted file mode 100644 index b5f44aa497..0000000000 --- a/docs/assets/js/430.f2cbef53.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[430],{728:function(e,t,r){"use strict";r.r(t);var s=r(46),n=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),r("h3",{attrs:{id:"classes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/classes/_type_inherentofflinereport_.inherentofflinereport.html"}},[e._v("InherentOfflineReport")])],1)]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/431.42063ff2.js b/docs/assets/js/431.42063ff2.js deleted file mode 100644 index 43dc2950a4..0000000000 --- a/docs/assets/js/431.42063ff2.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[431],{729:function(t,a,e){"use strict";e.r(a);var i=e(46),s=Object(i.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_justification_.justification.html"}},[t._v("Justification")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/types/classes/_type_justification_.rhdjustification.html"}},[t._v("RhdJustification")])],1)]),t._v(" "),e("h3",{attrs:{id:"type-aliases"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/modules/_type_justification_.html#rhdjustificationvalue"}},[t._v("RhdJustificationValue")])],1)]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"type-aliases-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),e("p",[e("a",{attrs:{id:"rhdjustificationvalue"}})]),t._v(" "),e("h2",{attrs:{id:"rhdjustificationvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rhdjustificationvalue","aria-hidden":"true"}},[t._v("#")]),t._v(" RhdJustificationValue")]),t._v(" "),e("p",[e("strong",[t._v("Ƭ RhdJustificationValue")]),t._v(": "),e("em",[e("code",[t._v("object")])])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("type/Justification.ts:14"),e("OutboundLink")],1)])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/432.b47603bf.js b/docs/assets/js/432.b47603bf.js deleted file mode 100644 index b7e56859fe..0000000000 --- a/docs/assets/js/432.b47603bf.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[432],{731:function(e,t,a){"use strict";a.r(t);var s=a(46),r=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalue.html"}},[e._v("KeyValue")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_keyvalue_.keyvalueoption.html"}},[e._v("KeyValueOption")])],1)]),e._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/modules/_type_keyvalue_.html#keyvalueoptionvalue"}},[e._v("KeyValueOptionValue")])],1)]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"keyvalueoptionvalue"}})]),e._v(" "),a("h2",{attrs:{id:"keyvalueoptionvalue"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#keyvalueoptionvalue","aria-hidden":"true"}},[e._v("#")]),e._v(" KeyValueOptionValue")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ KeyValueOptionValue")]),e._v(": "),a("em",[e._v("["),a("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[e._v("AnyU8a")]),e._v(", "),a("code",[e._v("undefined")]),e._v(" | "),a("code",[e._v("string")]),e._v(" | "),a("code",[e._v("Uint8Array")]),e._v(" | "),a("code",[e._v("number")]),e._v("[]]")],1)]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L49",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/KeyValue.ts:49"),a("OutboundLink")],1)])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/433.4f152866.js b/docs/assets/js/433.4f152866.js deleted file mode 100644 index d67fa7c2d2..0000000000 --- a/docs/assets/js/433.4f152866.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[433],{732:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_lockperiods_.lockperiods.html"}},[t._v("LocKPeriods")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/434.cd85ac32.js b/docs/assets/js/434.cd85ac32.js deleted file mode 100644 index 0e2d372022..0000000000 --- a/docs/assets/js/434.cd85ac32.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[434],{734:function(t,e,r){"use strict";r.r(e);var s=r(46),o=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"classes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftatreport.html"}},[t._v("BftAtReport")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublecommit.html"}},[t._v("BftDoubleCommit")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html"}},[t._v("BftDoublePrepare")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftdoublepropose.html"}},[t._v("BftDoublePropose")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html"}},[t._v("BftProposeOutOfTurn")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorkind.html"}},[t._v("MisbehaviorKind")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/classes/_type_misbehaviorreport_.misbehaviorreport.html"}},[t._v("MisbehaviorReport")])],1)]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/435.55e8c3a4.js b/docs/assets/js/435.55e8c3a4.js deleted file mode 100644 index a0bcf48a4f..0000000000 --- a/docs/assets/js/435.55e8c3a4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[435],{735:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_newaccountoutcome_.newaccountoutcome.html"}},[t._v("NewAccountOutcome")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/436.b77a1376.js b/docs/assets/js/436.b77a1376.js deleted file mode 100644 index 9753214862..0000000000 --- a/docs/assets/js/436.b77a1376.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[436],{737:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_nonce_.nonce.html"}},[t._v("Nonce")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/437.69537313.js b/docs/assets/js/437.69537313.js deleted file mode 100644 index 12fed3e4e8..0000000000 --- a/docs/assets/js/437.69537313.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[437],{738:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_noncecompact_.noncecompact.html"}},[t._v("NonceCompact")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/438.6258626a.js b/docs/assets/js/438.6258626a.js deleted file mode 100644 index 49a975434d..0000000000 --- a/docs/assets/js/438.6258626a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[438],{740:function(t,s,e){"use strict";e.r(s);var r=e(46),a=Object(r.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_origin_.origin.html"}},[t._v("Origin")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/439.233d0a88.js b/docs/assets/js/439.233d0a88.js deleted file mode 100644 index ad78fb32a9..0000000000 --- a/docs/assets/js/439.233d0a88.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[439],{741:function(t,a,s){"use strict";s.r(a);var e=s(46),r=Object(e.a)({},function(){var t=this,a=t.$createElement,s=t._self._c||a;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_paraid_.paraid.html"}},[t._v("ParaId")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/44.8aeba118.js b/docs/assets/js/44.8aeba118.js deleted file mode 100644 index 572f741edc..0000000000 --- a/docs/assets/js/44.8aeba118.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{712:function(t,s,a){"use strict";a.r(s);var e=a(46),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),a("h4",{attrs:{id:"codecresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),a("h4",{attrs:{id:"subscriptionresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("strong",[t._v("ApiBase")])]),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("p",[t._v("↳ "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("h1",{attrs:{id:"implements"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),a("h1",{attrs:{id:"constructors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),a("p",[a("a",{attrs:{id:"constructor"}})]),t._v(" "),a("h2",{attrs:{id:"constructor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),a("p",[t._v("⊕ "),a("strong",[t._v("new ApiBase")]),t._v("(provider?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(", type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v("): "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:81"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Create an instance of the class")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Api")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isReady")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" provider")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(" "),a("td",[t._v("{}")])]),t._v(" "),a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("td",[t._v("-")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"accessors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),a("p",[a("a",{attrs:{id:"derive"}})]),t._v(" "),a("h2",{attrs:{id:"derive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[t._v("#")]),t._v(" derive")]),t._v(" "),a("p",[a("strong",[t._v("get derive")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:196"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Derived results that are injected into the API, allowing for combinations of various query results.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'best number'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"genesishash"}})]),t._v(" "),a("h2",{attrs:{id:"genesishash"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[t._v("#")]),t._v(" genesisHash")]),t._v(" "),a("p",[a("strong",[t._v("get genesisHash")]),t._v("(): "),a("code",[t._v("Hash")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:132"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Hash")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),a("h2",{attrs:{id:"hassubscriptions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),a("p",[a("strong",[t._v("get hasSubscriptions")]),t._v("(): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:141"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("true")]),t._v(" when subscriptions are supported")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"libraryinfo"}})]),t._v(" "),a("h2",{attrs:{id:"libraryinfo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#libraryinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" libraryInfo")]),t._v(" "),a("p",[a("strong",[t._v("get libraryInfo")]),t._v("(): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:148"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The library information name & version (from package.json)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"query"}})]),t._v(" "),a("h2",{attrs:{id:"query"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[t._v("#")]),t._v(" query")]),t._v(" "),a("p",[a("strong",[t._v("get query")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:216"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[t._v("All calls inside the namespace, is denoted by "),a("code",[t._v("section")]),t._v("."),a("code",[t._v("method")]),t._v(" and may take an optional query parameter. As an example, "),a("code",[t._v("api.query.timestamp.now()")]),t._v(" (current block timestamp) does not take parameters, while "),a("code",[t._v("api.query.system.accountNonce()")]),t._v(" (retrieving the associated nonce for an account), takes the "),a("code",[t._v("AccountId")]),t._v(" as a parameter.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("accountId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new balance'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpc"}})]),t._v(" "),a("h2",{attrs:{id:"rpc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[t._v("#")]),t._v(" rpc")]),t._v(" "),a("p",[a("strong",[t._v("get rpc")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:236"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic "),a("code",[t._v("api.query")]),t._v(" and "),a("code",[t._v("api.tx")]),t._v(" sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.")]),t._v(" "),a("p",[t._v("RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new header'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimemetadata"}})]),t._v(" "),a("h2",{attrs:{id:"runtimemetadata"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeMetadata")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeMetadata")]),t._v("(): "),a("code",[t._v("Metadata")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:155"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Metadata")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimeversion"}})]),t._v(" "),a("h2",{attrs:{id:"runtimeversion"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeVersion")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeVersion")]),t._v("(): "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:164"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the version information for the current runtime.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tx"}})]),t._v(" "),a("h2",{attrs:{id:"tx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[t._v("#")]),t._v(" tx")]),t._v(" "),a("p",[a("strong",[t._v("get tx")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:254"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("recipientId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("keyPair"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'tx status'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"type"}})]),t._v(" "),a("h2",{attrs:{id:"type"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),a("p",[a("strong",[t._v("get type")]),t._v("(): "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:173"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The type of this API instance, either 'rxjs' or 'promise'")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),a("p",[a("a",{attrs:{id:"disconnect"}})]),t._v(" "),a("h2",{attrs:{id:"disconnect"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("disconnect")]),t._v("(): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:263"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Disconnect from the underlying provider, halting all comms")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"on"}})]),t._v(" "),a("h2",{attrs:{id:"on"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("on")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:286"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"once"}})]),t._v(" "),a("h2",{attrs:{id:"once"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("once")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:311"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an one-time eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"registertypes"}})]),t._v(" "),a("h2",{attrs:{id:"registertypes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#registertypes","aria-hidden":"true"}},[t._v("#")]),t._v(" registerTypes")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("registerTypes")]),t._v("(types?: "),a("em",[a("code",[t._v("RegistryTypes")])]),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:320"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Register additional user-defined of chain-specific types in the type registry")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" types")]),t._v(" "),a("td",[a("code",[t._v("RegistryTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"setsigner"}})]),t._v(" "),a("h2",{attrs:{id:"setsigner"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setsigner","aria-hidden":"true"}},[t._v("#")]),t._v(" setSigner")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("setSigner")]),t._v("(signer: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:180"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("signer")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/440.ddb31beb.js b/docs/assets/js/440.ddb31beb.js deleted file mode 100644 index ea3329caa2..0000000000 --- a/docs/assets/js/440.ddb31beb.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[440],{743:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_perbill_.perbill.html"}},[t._v("Perbill")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/441.4822f02c.js b/docs/assets/js/441.4822f02c.js deleted file mode 100644 index 11e370d92f..0000000000 --- a/docs/assets/js/441.4822f02c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[441],{744:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_permill_.permill.html"}},[t._v("Permill")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/442.b941fe1e.js b/docs/assets/js/442.b941fe1e.js deleted file mode 100644 index 426844eca2..0000000000 --- a/docs/assets/js/442.b941fe1e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[442],{747:function(e,t,s){"use strict";s.r(t);var a=s(46),r=Object(a.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html"}},[e._v("PrefabWasmModule")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/443.4cf74cfd.js b/docs/assets/js/443.4cf74cfd.js deleted file mode 100644 index 24c42c5419..0000000000 --- a/docs/assets/js/443.4cf74cfd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[443],{746:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_propindex_.propindex.html"}},[t._v("PropIndex")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/444.c39a1007.js b/docs/assets/js/444.c39a1007.js deleted file mode 100644 index 27eeb803ef..0000000000 --- a/docs/assets/js/444.c39a1007.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[444],{750:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_proposal_.proposal.html"}},[t._v("Proposal")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/445.03050f12.js b/docs/assets/js/445.03050f12.js deleted file mode 100644 index 9e7be680f2..0000000000 --- a/docs/assets/js/445.03050f12.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[445],{749:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_proposalindex_.proposalindex.html"}},[t._v("ProposalIndex")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/446.889f7a8c.js b/docs/assets/js/446.889f7a8c.js deleted file mode 100644 index b3e7b57ca4..0000000000 --- a/docs/assets/js/446.889f7a8c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[446],{753:function(e,t,s){"use strict";s.r(t);var r=s(46),a=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referendumindex_.referendumindex.html"}},[e._v("ReferendumIndex")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/447.2ec94099.js b/docs/assets/js/447.2ec94099.js deleted file mode 100644 index 6baf12289c..0000000000 --- a/docs/assets/js/447.2ec94099.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[447],{752:function(e,t,s){"use strict";s.r(t);var r=s(46),a=Object(r.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_referenduminfo_.referenduminfo.html"}},[e._v("ReferendumInfo")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/448.162c943f.js b/docs/assets/js/448.162c943f.js deleted file mode 100644 index b1c917713d..0000000000 --- a/docs/assets/js/448.162c943f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[448],{756:function(e,t,s){"use strict";s.r(t);var a=s(46),r=Object(a.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_schedule_.schedule.html"}},[e._v("Schedule")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/449.9d0db40b.js b/docs/assets/js/449.9d0db40b.js deleted file mode 100644 index 255b0738e3..0000000000 --- a/docs/assets/js/449.9d0db40b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[449],{754:function(e,t,s){"use strict";s.r(t);var a=s(46),r=Object(a.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_seedof_.seedof.html"}},[e._v("SeedOf")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/45.c2214929.js b/docs/assets/js/45.c2214929.js deleted file mode 100644 index 4ff6bc8cc2..0000000000 --- a/docs/assets/js/45.c2214929.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{500:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-api-promise"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-api-promise","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/api/promise")]),t._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview","aria-hidden":"true"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": ApiPromise")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static "),a("code",[t._v(".create(...)")]),t._v(". Subscription calls utilise "),a("code",[t._v("(value) => {}")]),t._v(" callbacks to pass through the latest values.")]),t._v(" "),a("p",[t._v("The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("see")])]),t._v(": "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Making rpc calls -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" ApiPromise "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via static create")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// make a subscription to the network head")]),t._v("\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br")])]),a("p",[t._v("Subscribing to chain state -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" WsProvider "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise a provider with a specific endpoint")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'wss://example.com:9944'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via isReady & new with specific provider")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ApiPromise")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve the block target time")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" blockPeriod "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blockPeriod")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" last "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to the current block timestamp, updates automatically (callback provided)")]),t._v("\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" elapsed "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" last\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`, ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" last"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("s since last`")])]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n last "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`timestamp ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("elapsed"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" (")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockPeriod"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("s target)`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br")])]),a("p",[t._v("Submitting a transaction -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" ApiPromise "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nApiPromise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" nonce "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("accountNonce")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create transfer")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("bob"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("12345")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// sign the transcation")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("sign")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" nonce "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// send the transaction (optional status callback)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("send")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`current status ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("type"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve the submitted extrinsic hash")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("hash"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`submitted with hash ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("hash"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br")])]),a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("strong",[t._v("↳ ApiPromise")])]),t._v(" "),a("h1",{attrs:{id:"implements"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1)]),t._v(" "),a("h1",{attrs:{id:"constructors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),a("p",[a("a",{attrs:{id:"constructor"}})]),t._v(" "),a("h2",{attrs:{id:"constructor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),a("p",[t._v("⊕ "),a("strong",[t._v("new ApiPromise")]),t._v("(options?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v("): "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("p",[a("em",[t._v("Overrides "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L127",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Api.ts:127"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Creates an instance of the ApiPromise class")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Api")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(" "),a("td",[t._v("Options to create an instance. This can be either "),a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" or an [[WsProvider]].")],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"accessors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),a("p",[a("a",{attrs:{id:"derive"}})]),t._v(" "),a("h2",{attrs:{id:"derive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[t._v("#")]),t._v(" derive")]),t._v(" "),a("p",[a("strong",[t._v("get derive")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#derive"}},[t._v("derive")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:196"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Derived results that are injected into the API, allowing for combinations of various query results.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'best number'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"genesishash"}})]),t._v(" "),a("h2",{attrs:{id:"genesishash"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[t._v("#")]),t._v(" genesisHash")]),t._v(" "),a("p",[a("strong",[t._v("get genesisHash")]),t._v("(): "),a("code",[t._v("Hash")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#genesishash"}},[t._v("genesisHash")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:132"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Hash")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),a("h2",{attrs:{id:"hassubscriptions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),a("p",[a("strong",[t._v("get hasSubscriptions")]),t._v("(): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#hassubscriptions"}},[t._v("hasSubscriptions")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:141"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("true")]),t._v(" when subscriptions are supported")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"isready"}})]),t._v(" "),a("h2",{attrs:{id:"isready"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isready","aria-hidden":"true"}},[t._v("#")]),t._v(" isReady")]),t._v(" "),a("p",[a("strong",[t._v("get isReady")]),t._v("(): "),a("code",[t._v("Promise")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L161",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Api.ts:161"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Promise that returns the first time we are connected and loaded")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Promise")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"libraryinfo"}})]),t._v(" "),a("h2",{attrs:{id:"libraryinfo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#libraryinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" libraryInfo")]),t._v(" "),a("p",[a("strong",[t._v("get libraryInfo")]),t._v("(): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#libraryinfo"}},[t._v("libraryInfo")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:148"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The library information name & version (from package.json)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"query"}})]),t._v(" "),a("h2",{attrs:{id:"query"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[t._v("#")]),t._v(" query")]),t._v(" "),a("p",[a("strong",[t._v("get query")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#query"}},[t._v("query")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:216"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[t._v("All calls inside the namespace, is denoted by "),a("code",[t._v("section")]),t._v("."),a("code",[t._v("method")]),t._v(" and may take an optional query parameter. As an example, "),a("code",[t._v("api.query.timestamp.now()")]),t._v(" (current block timestamp) does not take parameters, while "),a("code",[t._v("api.query.system.accountNonce()")]),t._v(" (retrieving the associated nonce for an account), takes the "),a("code",[t._v("AccountId")]),t._v(" as a parameter.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("accountId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new balance'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpc"}})]),t._v(" "),a("h2",{attrs:{id:"rpc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[t._v("#")]),t._v(" rpc")]),t._v(" "),a("p",[a("strong",[t._v("get rpc")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#rpc"}},[t._v("rpc")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:236"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic "),a("code",[t._v("api.query")]),t._v(" and "),a("code",[t._v("api.tx")]),t._v(" sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.")]),t._v(" "),a("p",[t._v("RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new header'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimemetadata"}})]),t._v(" "),a("h2",{attrs:{id:"runtimemetadata"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeMetadata")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeMetadata")]),t._v("(): "),a("code",[t._v("Metadata")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimemetadata"}},[t._v("runtimeMetadata")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:155"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Metadata")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimeversion"}})]),t._v(" "),a("h2",{attrs:{id:"runtimeversion"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeVersion")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeVersion")]),t._v("(): "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimeversion"}},[t._v("runtimeVersion")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:164"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the version information for the current runtime.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tx"}})]),t._v(" "),a("h2",{attrs:{id:"tx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[t._v("#")]),t._v(" tx")]),t._v(" "),a("p",[a("strong",[t._v("get tx")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#tx"}},[t._v("tx")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:254"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("recipientId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("keyPair"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'tx status'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("a",{attrs:{href:""}},[t._v("CodecResult")]),t._v(", "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"type"}})]),t._v(" "),a("h2",{attrs:{id:"type"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),a("p",[a("strong",[t._v("get type")]),t._v("(): "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#type"}},[t._v("type")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:173"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The type of this API instance, either 'rxjs' or 'promise'")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),a("p",[a("a",{attrs:{id:"clone"}})]),t._v(" "),a("h2",{attrs:{id:"clone"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[t._v("#")]),t._v(" clone")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("clone")]),t._v("(): "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L168",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Api.ts:168"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a clone of this ApiPromise instance (new underlying provider connection)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"combinelatest"}})]),t._v(" "),a("h2",{attrs:{id:"combinelatest"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#combinelatest","aria-hidden":"true"}},[t._v("#")]),t._v(" combineLatest")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("combineLatest")]),t._v("(fns: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(" | ["),a("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(", "),a("code",[t._v("Array")]),t._v("]>")],1),t._v(", callback: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorcallback"}},[t._v("CombinatorCallback")])],1),t._v("): "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L195",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Api.ts:195"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Creates a combinator that can be used to combine the latest results from multiple subscriptions")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" address "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5DTestUPts3kjeXSTMyerHihn1uwMfLj8vU8sqF7qYrFacT7'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// combines values from balance & nonce as it updates")]),t._v("\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("combineLatest")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("subscribeNewHead"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("freeBalance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("accountNonce")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" cb"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("head"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nonce"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`#")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("head"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("number"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(": You have ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" units, with ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("nonce"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" transactions sent`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("fns")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(" | ["),a("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(", "),a("code",[t._v("Array")]),t._v("]>")],1),t._v(" "),a("td",[t._v("An array of function to combine, each in the form of `(cb: (value: void)) => void`")])]),t._v(" "),a("tr",[a("td",[t._v("callback")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorcallback"}},[t._v("CombinatorCallback")])],1),t._v(" "),a("td",[t._v("A callback that will return an Array of all the values this combinator has been applied to")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("a",{attrs:{href:""}},[t._v("SubscriptionResult")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"disconnect"}})]),t._v(" "),a("h2",{attrs:{id:"disconnect"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("disconnect")]),t._v("(): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:263"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Disconnect from the underlying provider, halting all comms")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"on"}})]),t._v(" "),a("h2",{attrs:{id:"on"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("on")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#on"}},[t._v("on")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:286"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"once"}})]),t._v(" "),a("h2",{attrs:{id:"once"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("once")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#once"}},[t._v("once")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:311"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an one-time eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"registertypes"}})]),t._v(" "),a("h2",{attrs:{id:"registertypes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#registertypes","aria-hidden":"true"}},[t._v("#")]),t._v(" registerTypes")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("registerTypes")]),t._v("(types?: "),a("em",[a("code",[t._v("RegistryTypes")])]),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:320"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Register additional user-defined of chain-specific types in the type registry")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" types")]),t._v(" "),a("td",[a("code",[t._v("RegistryTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"setsigner"}})]),t._v(" "),a("h2",{attrs:{id:"setsigner"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setsigner","aria-hidden":"true"}},[t._v("#")]),t._v(" setSigner")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("setSigner")]),t._v("(signer: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:180"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("signer")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"create"}})]),t._v(" "),a("h2",{attrs:{id:"static-create"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-create","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" create")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("create")]),t._v("(options?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v("): "),a("code",[t._v("Promise")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Api.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Api.ts:125"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Creates an ApiPromise instance using the supplied provider. Returns an Promise containing the actual Api instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nApi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" timestamp "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`lastest block timestamp ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" options")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(" "),a("td",[t._v("{}")]),t._v(" "),a("td",[t._v("options that is passed to the class contructor. Can be either "),a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" or a provider (see the constructor arguments)")],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Promise")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")]),t._v(">")],1),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/450.5083ce7e.js b/docs/assets/js/450.5083ce7e.js deleted file mode 100644 index c65c1740bb..0000000000 --- a/docs/assets/js/450.5083ce7e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[450],{751:function(s,e,t){"use strict";t.r(e);var a=t(46),r=Object(a.a)({},function(){var s=this,e=s.$createElement,t=s._self._c||e;return t("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[t("h1",{attrs:{id:"index"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[s._v("#")]),s._v(" Index")]),s._v(" "),t("h3",{attrs:{id:"classes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[s._v("#")]),s._v(" Classes")]),s._v(" "),t("ul",[t("li",[t("router-link",{attrs:{to:"/types/classes/_type_sessionkey_.sessionkey.html"}},[s._v("SessionKey")])],1)]),s._v(" "),t("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/451.11fca1f7.js b/docs/assets/js/451.11fca1f7.js deleted file mode 100644 index 9b9be1d486..0000000000 --- a/docs/assets/js/451.11fca1f7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[451],{748:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.ed25519signature.html"}},[t._v("Ed25519Signature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.signature.html"}},[t._v("Signature")])],1),t._v(" "),s("li",[s("router-link",{attrs:{to:"/types/classes/_type_signature_.sr25519signature.html"}},[t._v("Sr25519Signature")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/452.5d4a004c.js b/docs/assets/js/452.5d4a004c.js deleted file mode 100644 index 9da84d1406..0000000000 --- a/docs/assets/js/452.5d4a004c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[452],{745:function(t,a,e){"use strict";e.r(a);var s=e(46),r=Object(s.a)({},function(){var t=this,a=t.$createElement,e=t._self._c||a;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_signaturepayload_.signaturepayload.html"}},[t._v("SignaturePayload")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/453.a8206442.js b/docs/assets/js/453.a8206442.js deleted file mode 100644 index 88e66a5d0d..0000000000 --- a/docs/assets/js/453.a8206442.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[453],{742:function(e,t,a){"use strict";a.r(t);var r=a(46),n=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.nextauthority.html"}},[e._v("NextAuthority")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/types/classes/_type_storedpendingchange_.storedpendingchange.html"}},[e._v("StoredPendingChange")])],1)]),e._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/types/modules/_type_storedpendingchange_.html#nextauthorityvalue"}},[e._v("NextAuthorityValue")])],1),e._v(" "),a("li",[a("router-link",{attrs:{to:"/types/modules/_type_storedpendingchange_.html#storedpendingchangevalue"}},[e._v("StoredPendingChangeValue")])],1)]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"nextauthorityvalue"}})]),e._v(" "),a("h2",{attrs:{id:"nextauthorityvalue"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#nextauthorityvalue","aria-hidden":"true"}},[e._v("#")]),e._v(" NextAuthorityValue")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ NextAuthorityValue")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/StoredPendingChange.ts:14"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr"),e._v(" "),a("p",[a("a",{attrs:{id:"storedpendingchangevalue"}})]),e._v(" "),a("h2",{attrs:{id:"storedpendingchangevalue"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#storedpendingchangevalue","aria-hidden":"true"}},[e._v("#")]),e._v(" StoredPendingChangeValue")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ StoredPendingChangeValue")]),e._v(": "),a("em",[a("code",[e._v("object")])])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[e._v("type/StoredPendingChange.ts:19"),a("OutboundLink")],1)])]),e._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type declaration")]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/454.3040d79f.js b/docs/assets/js/454.3040d79f.js deleted file mode 100644 index 4c278a31c9..0000000000 --- a/docs/assets/js/454.3040d79f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[454],{739:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/types/classes/_type_validatorprefs_.validatorprefs.html"}},[t._v("ValidatorPrefs")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/455.e3040085.js b/docs/assets/js/455.e3040085.js deleted file mode 100644 index d741903576..0000000000 --- a/docs/assets/js/455.e3040085.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[455],{736:function(e,t,s){"use strict";s.r(t);var a=s(46),r=Object(a.a)({},function(){var e=this,t=e.$createElement,s=e._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[e._v("#")]),e._v(" Classes")]),e._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vestingschedule_.vestingschedule.html"}},[e._v("VestingSchedule")])],1)]),e._v(" "),s("hr")])},[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/456.4e7ac5cc.js b/docs/assets/js/456.4e7ac5cc.js deleted file mode 100644 index 1dfde86831..0000000000 --- a/docs/assets/js/456.4e7ac5cc.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[456],{733:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_vote_.vote.html"}},[t._v("Vote")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/457.99bd9def.js b/docs/assets/js/457.99bd9def.js deleted file mode 100644 index 4e58296507..0000000000 --- a/docs/assets/js/457.99bd9def.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[457],{730:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_voteindex_.voteindex.html"}},[t._v("VoteIndex")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/458.135f5897.js b/docs/assets/js/458.135f5897.js deleted file mode 100644 index c3e79ceabd..0000000000 --- a/docs/assets/js/458.135f5897.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[458],{727:function(t,e,s){"use strict";s.r(e);var r=s(46),a=Object(r.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),s("h3",{attrs:{id:"classes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),s("ul",[s("li",[s("router-link",{attrs:{to:"/types/classes/_type_votethreshold_.votethreshold.html"}},[t._v("VoteThreshold")])],1)]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/459.65aeb544.js b/docs/assets/js/459.65aeb544.js deleted file mode 100644 index 0a393d2847..0000000000 --- a/docs/assets/js/459.65aeb544.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[459],{724:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/interfaces/_types_.runtimeversioninterface.html"}},[t._v("RuntimeVersionInterface")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anynumber"}},[t._v("AnyNumber")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anystring"}},[t._v("AnyString")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#anyu8a"}},[t._v("AnyU8a")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#codecarg"}},[t._v("CodecArg")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#codeccallback"}},[t._v("CodecCallback")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#codecto"}},[t._v("CodecTo")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#constructordef"}},[t._v("ConstructorDef")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#registrytypes"}},[t._v("RegistryTypes")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#signatureoptions"}},[t._v("SignatureOptions")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/types/modules/_types_.html#typedef"}},[t._v("TypeDef")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"anynumber"}})]),t._v(" "),r("h2",{attrs:{id:"anynumber"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#anynumber","aria-hidden":"true"}},[t._v("#")]),t._v(" AnyNumber")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ AnyNumber")]),t._v(": "),r("em",[r("code",[t._v("BN")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:17"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"anystring"}})]),t._v(" "),r("h2",{attrs:{id:"anystring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#anystring","aria-hidden":"true"}},[t._v("#")]),t._v(" AnyString")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ AnyString")]),t._v(": "),r("em",[r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("String")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"anyu8a"}})]),t._v(" "),r("h2",{attrs:{id:"anyu8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#anyu8a","aria-hidden":"true"}},[t._v("#")]),t._v(" AnyU8a")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ AnyU8a")]),t._v(": "),r("em",[r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("number")]),t._v("> | "),r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"codecarg"}})]),t._v(" "),r("h2",{attrs:{id:"codecarg"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecarg","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecArg")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ CodecArg")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/types/interfaces/_types_.codec.html"}},[t._v("Codec")]),t._v(" | "),r("code",[t._v("BN")]),t._v(" | "),r("code",[t._v("Boolean")]),t._v(" | "),r("code",[t._v("String")]),t._v(" | "),r("code",[t._v("Uint8Array")]),t._v(" | "),r("code",[t._v("boolean")]),t._v(" | "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("CodecArgArray")]),t._v(" | "),r("code",[t._v("CodecArgObject")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:7"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"codeccallback"}})]),t._v(" "),r("h2",{attrs:{id:"codeccallback"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codeccallback","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecCallback")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ CodecCallback")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(result: "),r("em",[r("code",[t._v("T")])]),t._v("): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("result")]),t._v(" "),r("td",[r("code",[t._v("T")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"codecto"}})]),t._v(" "),r("h2",{attrs:{id:"codecto"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecto","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecTo")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ CodecTo")]),t._v(": "),r("em",[t._v('"toHex" | "toJSON" | "toString" | "toU8a"')])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:68"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"constructordef"}})]),t._v(" "),r("h2",{attrs:{id:"constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" ConstructorDef")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ConstructorDef")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L74",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:74"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"registrytypes"}})]),t._v(" "),r("h2",{attrs:{id:"registrytypes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#registrytypes","aria-hidden":"true"}},[t._v("#")]),t._v(" RegistryTypes")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ RegistryTypes")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L78",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:78"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("[name: "),r("code",[t._v("string")]),t._v("]: "),r("router-link",{attrs:{to:"/types/interfaces/_types_.constructor.html"}},[t._v("Constructor")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("object")])],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signatureoptions"}})]),t._v(" "),r("h2",{attrs:{id:"signatureoptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signatureoptions","aria-hidden":"true"}},[t._v("#")]),t._v(" SignatureOptions")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ SignatureOptions")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L91",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:91"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"typedef"}})]),t._v(" "),r("h2",{attrs:{id:"typedef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#typedef","aria-hidden":"true"}},[t._v("#")]),t._v(" TypeDef")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ TypeDef")]),t._v(": "),r("em",[r("code",[t._v("object")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/46.94e69ce6.js b/docs/assets/js/46.94e69ce6.js deleted file mode 100644 index d367b2c8e6..0000000000 --- a/docs/assets/js/46.94e69ce6.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{387:function(t,r,o){"use strict";o.r(r);var a=o(46),e=Object(a.a)({},function(){var t=this,r=t.$createElement,o=t._self._c||r;return o("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[o("h1",{attrs:{id:"hierarchy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),o("p",[o("strong",[t._v("Combinator")])]),t._v(" "),o("h1",{attrs:{id:"constructors"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),o("p",[o("a",{attrs:{id:"constructor"}})]),t._v(" "),o("h2",{attrs:{id:"constructor"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),o("p",[t._v("⊕ "),o("strong",[t._v("new Combinator")]),t._v("(fns: "),o("em",[o("code",[t._v("Array")]),t._v("<"),o("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(" | ["),o("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(", "),o("code",[t._v("Array")]),t._v("]>")],1),t._v(", callback: "),o("em",[o("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorcallback"}},[t._v("CombinatorCallback")])],1),t._v("): "),o("router-link",{attrs:{to:"/api/classes/_promise_combinator_.combinator.html"}},[t._v("Combinator")])],1),t._v(" "),o("p",[o("em",[t._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Combinator.ts:21"),o("OutboundLink")],1)])]),t._v(" "),o("p",[o("strong",[t._v("Parameters:")])]),t._v(" "),o("table",[o("thead",[o("tr",[o("th",[t._v("Name")]),t._v(" "),o("th",[t._v("Type")])])]),t._v(" "),o("tbody",[o("tr",[o("td",[t._v("fns")]),t._v(" "),o("td",[o("code",[t._v("Array")]),t._v("<"),o("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(" | ["),o("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")]),t._v(", "),o("code",[t._v("Array")]),t._v("]>")],1)]),t._v(" "),o("tr",[o("td",[t._v("callback")]),t._v(" "),o("td",[o("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorcallback"}},[t._v("CombinatorCallback")])],1)])])]),t._v(" "),o("p",[o("strong",[t._v("Returns:")]),t._v(" "),o("router-link",{attrs:{to:"/api/classes/_promise_combinator_.combinator.html"}},[t._v("Combinator")])],1),t._v(" "),o("hr"),t._v(" "),o("h1",{attrs:{id:"methods"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),o("p",[o("a",{attrs:{id:"unsubscribe"}})]),t._v(" "),o("h2",{attrs:{id:"unsubscribe"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#unsubscribe","aria-hidden":"true"}},[t._v("#")]),t._v(" unsubscribe")]),t._v(" "),o("p",[t._v("▸ "),o("strong",[t._v("unsubscribe")]),t._v("(): "),o("code",[t._v("void")])]),t._v(" "),o("p",[o("em",[t._v("Defined in "),o("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L67",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Combinator.ts:67"),o("OutboundLink")],1)])]),t._v(" "),o("p",[o("strong",[t._v("Returns:")]),t._v(" "),o("code",[t._v("void")])]),t._v(" "),o("hr")])},[],!1,null,null,null);r.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/460.46c9c6c5.js b/docs/assets/js/460.46c9c6c5.js deleted file mode 100644 index 990f461dd2..0000000000 --- a/docs/assets/js/460.46c9c6c5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[460],{247:function(n,w,o){}}]); \ No newline at end of file diff --git a/docs/assets/js/47.f9256cd5.js b/docs/assets/js/47.f9256cd5.js deleted file mode 100644 index f56016fab8..0000000000 --- a/docs/assets/js/47.f9256cd5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[47],{497:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-api-rx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-api-rx","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/api/rx")]),t._v(" "),a("h2",{attrs:{id:"overview"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#overview","aria-hidden":"true"}},[t._v("#")]),t._v(" Overview")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": ApiRx")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, all interface calls return RxJS Observables, including the static "),a("code",[t._v(".create(...)")]),t._v(". In the same fashion and subscription-based methods return long-running Observables that update with the latest values.")]),t._v(" "),a("p",[t._v("The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding "),a("code",[t._v(".subscribe")]),t._v(" and "),a("code",[t._v(".pipe")]),t._v(" on Observables will unlock full-scale use thereof.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("see")])]),t._v(": "),a("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Making rpc calls -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" ApiRx "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via Promise & static create")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// make a call to retrieve the current network head")]),t._v("\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br")])]),a("p",[t._v("Subscribing to chain state -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" combineLatest "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" pairwise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" WsProvider "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise a provider with a specific endpoint")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'wss://example.com:9944'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// initialise via isReady & new with specific provider")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ApiRx")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("combineLatest")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blockPeriod")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pairwise")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("blockPeriod"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" elapsed "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`timestamp ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" \\nelapsed ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("elapsed"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" \\n(")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockPeriod"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("s target)`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br")])]),a("p",[t._v("Submitting a transaction -")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" first"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" ApiRx "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" testingPairs "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring/testingPairs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("testingPairs")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get api via Promise")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve nonce for the account")]),t._v("\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("accountNonce")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("first")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// pipe nonce into transfer")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("nonce"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create transfer")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("bob"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("12345")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// sign the transcation")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("sign")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("keyring"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" nonce "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// send the transaction")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("send")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to overall result")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Finalised'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Completed at block hash'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br"),a("span",{staticClass:"line-number"},[t._v("23")]),a("br"),a("span",{staticClass:"line-number"},[t._v("24")]),a("br"),a("span",{staticClass:"line-number"},[t._v("25")]),a("br"),a("span",{staticClass:"line-number"},[t._v("26")]),a("br"),a("span",{staticClass:"line-number"},[t._v("27")]),a("br"),a("span",{staticClass:"line-number"},[t._v("28")]),a("br"),a("span",{staticClass:"line-number"},[t._v("29")]),a("br"),a("span",{staticClass:"line-number"},[t._v("30")]),a("br"),a("span",{staticClass:"line-number"},[t._v("31")]),a("br"),a("span",{staticClass:"line-number"},[t._v("32")]),a("br")])]),a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("strong",[t._v("↳ ApiRx")])]),t._v(" "),a("h1",{attrs:{id:"implements"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("li",[a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1)]),t._v(" "),a("h1",{attrs:{id:"constructors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),a("p",[a("a",{attrs:{id:"constructor"}})]),t._v(" "),a("h2",{attrs:{id:"constructor"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),a("p",[t._v("⊕ "),a("strong",[t._v("new ApiRx")]),t._v("(provider?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v("): "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("p",[a("em",[t._v("Overrides "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:141"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Create an instance of the ApiRx class")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Api")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" provider")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"accessors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),a("p",[a("a",{attrs:{id:"derive"}})]),t._v(" "),a("h2",{attrs:{id:"derive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[t._v("#")]),t._v(" derive")]),t._v(" "),a("p",[a("strong",[t._v("get derive")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#derive"}},[t._v("derive")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:196"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Derived results that are injected into the API, allowing for combinations of various query results.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'best number'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"genesishash"}})]),t._v(" "),a("h2",{attrs:{id:"genesishash"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[t._v("#")]),t._v(" genesisHash")]),t._v(" "),a("p",[a("strong",[t._v("get genesisHash")]),t._v("(): "),a("code",[t._v("Hash")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#genesishash"}},[t._v("genesisHash")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:132"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Hash")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),a("h2",{attrs:{id:"hassubscriptions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),a("p",[a("strong",[t._v("get hasSubscriptions")]),t._v("(): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#hassubscriptions"}},[t._v("hasSubscriptions")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:141"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": "),a("code",[t._v("true")]),t._v(" when subscriptions are supported")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"isconnected"}})]),t._v(" "),a("h2",{attrs:{id:"isconnected"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isconnected","aria-hidden":"true"}},[t._v("#")]),t._v(" isConnected")]),t._v(" "),a("p",[a("strong",[t._v("get isConnected")]),t._v("(): "),a("code",[t._v("Observable")]),t._v("<"),a("code",[t._v("boolean")]),t._v(">")]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L181",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:181"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Observable that carries the connected state for the provider. Results in a boolean flag that is true/false based on the connectivity.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Observable")]),t._v("<"),a("code",[t._v("boolean")]),t._v(">")]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"isready"}})]),t._v(" "),a("h2",{attrs:{id:"isready"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#isready","aria-hidden":"true"}},[t._v("#")]),t._v(" isReady")]),t._v(" "),a("p",[a("strong",[t._v("get isReady")]),t._v("(): "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L188",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:188"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Observable that returns the first time we are connected and loaded")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"libraryinfo"}})]),t._v(" "),a("h2",{attrs:{id:"libraryinfo"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#libraryinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" libraryInfo")]),t._v(" "),a("p",[a("strong",[t._v("get libraryInfo")]),t._v("(): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#libraryinfo"}},[t._v("libraryInfo")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:148"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The library information name & version (from package.json)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"query"}})]),t._v(" "),a("h2",{attrs:{id:"query"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[t._v("#")]),t._v(" query")]),t._v(" "),a("p",[a("strong",[t._v("get query")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#query"}},[t._v("query")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:216"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[t._v("All calls inside the namespace, is denoted by "),a("code",[t._v("section")]),t._v("."),a("code",[t._v("method")]),t._v(" and may take an optional query parameter. As an example, "),a("code",[t._v("api.query.timestamp.now()")]),t._v(" (current block timestamp) does not take parameters, while "),a("code",[t._v("api.query.system.accountNonce()")]),t._v(" (retrieving the associated nonce for an account), takes the "),a("code",[t._v("AccountId")]),t._v(" as a parameter.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("accountId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new balance'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"rpc"}})]),t._v(" "),a("h2",{attrs:{id:"rpc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[t._v("#")]),t._v(" rpc")]),t._v(" "),a("p",[a("strong",[t._v("get rpc")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#rpc"}},[t._v("rpc")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:236"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic "),a("code",[t._v("api.query")]),t._v(" and "),a("code",[t._v("api.tx")]),t._v(" sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.")]),t._v(" "),a("p",[t._v("RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new header'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimemetadata"}})]),t._v(" "),a("h2",{attrs:{id:"runtimemetadata"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeMetadata")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeMetadata")]),t._v("(): "),a("code",[t._v("Metadata")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimemetadata"}},[t._v("runtimeMetadata")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:155"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Metadata")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"runtimeversion"}})]),t._v(" "),a("h2",{attrs:{id:"runtimeversion"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeVersion")]),t._v(" "),a("p",[a("strong",[t._v("get runtimeVersion")]),t._v("(): "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimeversion"}},[t._v("runtimeVersion")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:164"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains the version information for the current runtime.")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("RuntimeVersion")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tx"}})]),t._v(" "),a("h2",{attrs:{id:"tx"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[t._v("#")]),t._v(" tx")]),t._v(" "),a("p",[a("strong",[t._v("get tx")]),t._v("(): "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#tx"}},[t._v("tx")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:254"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("recipientId"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("balance"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("keyPair"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'tx status'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"type"}})]),t._v(" "),a("h2",{attrs:{id:"type"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),a("p",[a("strong",[t._v("get type")]),t._v("(): "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#type"}},[t._v("type")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:173"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": The type of this API instance, either 'rxjs' or 'promise'")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),a("hr"),t._v(" "),a("h1",{attrs:{id:"methods"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),a("p",[a("a",{attrs:{id:"clone"}})]),t._v(" "),a("h2",{attrs:{id:"clone"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clone","aria-hidden":"true"}},[t._v("#")]),t._v(" clone")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("clone")]),t._v("(): "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L195",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:195"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Returns a clone of this ApiRx instance (new underlying provider connection)")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"disconnect"}})]),t._v(" "),a("h2",{attrs:{id:"disconnect"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("disconnect")]),t._v("(): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:263"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Disconnect from the underlying provider, halting all comms")]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"on"}})]),t._v(" "),a("h2",{attrs:{id:"on"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("on")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#on"}},[t._v("on")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:286"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"once"}})]),t._v(" "),a("h2",{attrs:{id:"once"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("once")]),t._v("(type: "),a("em",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),a("em",[a("code",[t._v("function")])]),t._v("): "),a("code",[t._v("this")])]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#once"}},[t._v("once")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:311"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Attach an one-time eventemitter handler to listen to a specific event")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("type")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),a("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),a("tr",[a("td",[t._v("handler")]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("this")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"registertypes"}})]),t._v(" "),a("h2",{attrs:{id:"registertypes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#registertypes","aria-hidden":"true"}},[t._v("#")]),t._v(" registerTypes")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("registerTypes")]),t._v("(types?: "),a("em",[a("code",[t._v("RegistryTypes")])]),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:320"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Register additional user-defined of chain-specific types in the type registry")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" types")]),t._v(" "),a("td",[a("code",[t._v("RegistryTypes")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"setsigner"}})]),t._v(" "),a("h2",{attrs:{id:"setsigner"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setsigner","aria-hidden":"true"}},[t._v("#")]),t._v(" setSigner")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("setSigner")]),t._v("(signer: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v("): "),a("code",[t._v("void")])]),t._v(" "),a("p",[a("em",[t._v("Implementation of "),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")]),t._v("."),a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),a("p",[a("em",[t._v("Inherited from "),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:180"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("signer")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("void")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"create"}})]),t._v(" "),a("h2",{attrs:{id:"static-create"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-create","aria-hidden":"true"}},[t._v("#")]),t._v(" "),a("code",[t._v("")]),t._v(" create")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("create")]),t._v("(options?: "),a("em",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v("): "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/Api.ts#L139",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/Api.ts:139"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Creates an ApiRx instance using the supplied provider. Returns an Observable containing the actual Api instance.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/rx'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nApi"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br")])]),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),a("td",[a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),a("code",[t._v("ProviderInterface")])],1),t._v(" "),a("td",[t._v("options that is passed to the class contructor. Can be either "),a("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" or [[WsProvider]]")],1)])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Observable")]),t._v("<"),a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")]),t._v(">")],1),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/48.38486aa1.js b/docs/assets/js/48.38486aa1.js deleted file mode 100644 index 1f9294949d..0000000000 --- a/docs/assets/js/48.38486aa1.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{494:function(t,e,r){"use strict";r.r(e);var a=r(46),_=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("code",[t._v("ConstructorDef")])]),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Extrinsic")])]),t._v(" "),r("p",[r("strong",[t._v("↳ SubmittableExtrinsic")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("code",[t._v("Codec")])])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new SubmittableExtrinsic")]),t._v("(type: "),r("em",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(", api: "),r("em",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_rx"}},[t._v("ApiInterface$Rx")])],1),t._v(", onCall: "),r("em",[r("router-link",{attrs:{to:"/api/modules/_types_.html#oncalldefinition"}},[t._v("OnCallDefinition")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(", extrinsic: "),r("em",[r("code",[t._v("Extrinsic")]),t._v(" | "),r("code",[t._v("Method")])]),t._v("): "),r("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides Extrinsic.__constructor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:62"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1)]),t._v(" "),r("tr",[r("td",[t._v("api")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_rx"}},[t._v("ApiInterface$Rx")])],1)]),t._v(" "),r("tr",[r("td",[t._v("onCall")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/api/modules/_types_.html#oncalldefinition"}},[t._v("OnCallDefinition")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("tr",[r("td",[t._v("extrinsic")]),t._v(" "),r("td",[r("code",[t._v("Extrinsic")]),t._v(" | "),r("code",[t._v("Method")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.Type")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"args"}})]),t._v(" "),r("h2",{attrs:{id:"args"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#args","aria-hidden":"true"}},[t._v("#")]),t._v(" args")]),t._v(" "),r("p",[r("strong",[t._v("get args")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.args")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:76"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The arguments passed to for the call, exposes args so it is compatible with [[Method]]")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"callindex"}})]),t._v(" "),r("h2",{attrs:{id:"callindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#callindex","aria-hidden":"true"}},[t._v("#")]),t._v(" callIndex")]),t._v(" "),r("p",[r("strong",[t._v("get callIndex")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.callIndex")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:83"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The actual "),r("code",[t._v("[sectionIndex, methodIndex]")]),t._v(" as used in the Method")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"data"}})]),t._v(" "),r("h2",{attrs:{id:"data"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#data","aria-hidden":"true"}},[t._v("#")]),t._v(" data")]),t._v(" "),r("p",[r("strong",[t._v("get data")]),t._v("(): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.data")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L90",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:90"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The actual data for the Method")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.encodedLength")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Struct.encodedLength")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L97",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:97"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hash"}})]),t._v(" "),r("h2",{attrs:{id:"hash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),r("p",[r("strong",[t._v("get hash")]),t._v("(): "),r("code",[t._v("Hash")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.hash")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L106",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:106"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Convernience function, encodes the extrinsic and returns the actual hash")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Hash")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.isEmpty")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"issigned"}})]),t._v(" "),r("h2",{attrs:{id:"issigned"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#issigned","aria-hidden":"true"}},[t._v("#")]),t._v(" isSigned")]),t._v(" "),r("p",[r("strong",[t._v("get isSigned")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.isSigned")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L115",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:115"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": "),r("code",[t._v("true")]),t._v(" id the extrinsic is signed")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"length"}})]),t._v(" "),r("h2",{attrs:{id:"length"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#length","aria-hidden":"true"}},[t._v("#")]),t._v(" length")]),t._v(" "),r("p",[r("strong",[t._v("get length")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.length")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:122"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the encoded value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"meta"}})]),t._v(" "),r("h2",{attrs:{id:"meta"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),r("p",[r("strong",[t._v("get meta")]),t._v("(): "),r("code",[t._v("FunctionMetadata")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.meta")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:129"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The [[FunctionMetadata]] that describes the extrinsic")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("FunctionMetadata")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"method"}})]),t._v(" "),r("h2",{attrs:{id:"method"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),r("p",[r("strong",[t._v("get method")]),t._v("(): "),r("code",[t._v("Method")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.method")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L136",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:136"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The [[Method]] this extrinsic wraps")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Method")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signature"}})]),t._v(" "),r("h2",{attrs:{id:"signature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signature","aria-hidden":"true"}},[t._v("#")]),t._v(" signature")]),t._v(" "),r("p",[r("strong",[t._v("get signature")]),t._v("(): "),r("code",[t._v("ExtrinsicSignature")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.signature")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L143",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:143"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The [[ExtrinsicSignature]]")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("ExtrinsicSignature")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"addsignature"}})]),t._v(" "),r("h2",{attrs:{id:"addsignature"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#addsignature","aria-hidden":"true"}},[t._v("#")]),t._v(" addSignature")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("addSignature")]),t._v("(signer: "),r("em",[r("code",[t._v("Address")]),t._v(" | "),r("code",[t._v("Uint8Array")])]),t._v(", signature: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v(", nonce: "),r("em",[r("code",[t._v("AnyNumber")])]),t._v(", era?: "),r("em",[r("code",[t._v("Uint8Array")])]),t._v("): "),r("code",[t._v("Extrinsic")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.addSignature")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L150",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:150"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Add an [[ExtrinsicSignature]] to the extrinsic (already generated)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("signer")]),t._v(" "),r("td",[r("code",[t._v("Address")]),t._v(" | "),r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("signature")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])]),t._v(" "),r("tr",[r("td",[t._v("nonce")]),t._v(" "),r("td",[r("code",[t._v("AnyNumber")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" era")]),t._v(" "),r("td",[r("code",[t._v("Uint8Array")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Extrinsic")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.eq")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.get")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("Codec")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.getAtIndex")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Codec")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"send"}})]),t._v(" "),r("h2",{attrs:{id:"send"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#send","aria-hidden":"true"}},[t._v("#")]),t._v(" send")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("send")]),t._v("(): "),r("code",[t._v("SumbitableResultResult")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("send")]),t._v("(statusCb: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("SumbitableResultSubscription")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L135",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:135"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("SumbitableResultResult")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L136",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:136"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("statusCb")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("SumbitableResultSubscription")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("code",[t._v("Codec")])]),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Codec")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(account: "),r("em",[r("code",[t._v("KeyringPair")])]),t._v(", _options: "),r("em",[r("code",[t._v("Partial")]),t._v("<"),r("code",[t._v("SignatureOptions")]),t._v(">")]),t._v("): "),r("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),r("p",[r("em",[t._v("Overrides Extrinsic.sign")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:153"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("account")]),t._v(" "),r("td",[r("code",[t._v("KeyringPair")])])]),t._v(" "),r("tr",[r("td",[t._v("_options")]),t._v(" "),r("td",[r("code",[t._v("Partial")]),t._v("<"),r("code",[t._v("SignatureOptions")]),t._v(">")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"signandsend"}})]),t._v(" "),r("h2",{attrs:{id:"signandsend"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#signandsend","aria-hidden":"true"}},[t._v("#")]),t._v(" signAndSend")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("signAndSend")]),t._v("(account: "),r("em",[r("code",[t._v("KeyringPair")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("AccountId")]),t._v(" | "),r("code",[t._v("Address")])]),t._v(", options?: "),r("em",[r("code",[t._v("Partial")]),t._v("<"),r("code",[t._v("Partial")]),t._v("<"),r("code",[t._v("SignatureOptions")]),t._v(">>")]),t._v("): "),r("code",[t._v("SumbitableResultResult")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("signAndSend")]),t._v("(account: "),r("em",[r("code",[t._v("KeyringPair")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("AccountId")]),t._v(" | "),r("code",[t._v("Address")])]),t._v(", statusCb: "),r("em",[r("code",[t._v("StatusCb")])]),t._v("): "),r("code",[t._v("SumbitableResultSubscription")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L165",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:165"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("account")]),t._v(" "),r("td",[r("code",[t._v("KeyringPair")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("AccountId")]),t._v(" | "),r("code",[t._v("Address")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" options")]),t._v(" "),r("td",[r("code",[t._v("Partial")]),t._v("<"),r("code",[t._v("Partial")]),t._v("<"),r("code",[t._v("SignatureOptions")]),t._v(">>")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("SumbitableResultResult")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L166",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:166"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("account")]),t._v(" "),r("td",[r("code",[t._v("KeyringPair")]),t._v(" | "),r("code",[t._v("string")]),t._v(" | "),r("code",[t._v("AccountId")]),t._v(" | "),r("code",[t._v("Address")])])]),t._v(" "),r("tr",[r("td",[t._v("statusCb")]),t._v(" "),r("td",[r("code",[t._v("StatusCb")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("SumbitableResultSubscription")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.toArray")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.toHex")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Struct.toHex")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L168",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:168"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.toJSON")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Struct.toJSON")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L175",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:175"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.toU8a")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Struct.toU8a")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:183"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"decodeextrinsic"}})]),t._v(" "),r("h2",{attrs:{id:"static-decodeextrinsic"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-decodeextrinsic","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" decodeExtrinsic")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("decodeExtrinsic")]),t._v("(value: "),r("em",[r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("code",[t._v("AnyU8a")]),t._v(" | "),r("code",[t._v("Method")])]),t._v("): "),r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("number")]),t._v("> | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Extrinsic.decodeExtrinsic")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/type/Extrinsic.ts:44"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("code",[t._v("AnyU8a")]),t._v(" | "),r("code",[t._v("Method")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("ExtrinsicValue")]),t._v(" | "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("number")]),t._v("> | "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("code",[t._v("Constructor")]),t._v("<"),r("code",[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.with")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("code",[t._v("ConstructorDef")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Constructor")]),t._v("<"),r("code",[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/49.9d343381.js b/docs/assets/js/49.9d343381.js deleted file mode 100644 index 432b46b666..0000000000 --- a/docs/assets/js/49.9d343381.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{709:function(t,e,r){"use strict";r.r(e);var a=r(46),v=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"s-constructordef"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("code",[t._v("ConstructorDef")])]),t._v(" "),r("h4",{attrs:{id:"t-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#t-object","aria-hidden":"true"}},[t._v("#")]),t._v(" T : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"v-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#v-object","aria-hidden":"true"}},[t._v("#")]),t._v(" V : "),r("code",[t._v("object")])]),t._v(" "),r("h4",{attrs:{id:"e-object"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#e-object","aria-hidden":"true"}},[t._v("#")]),t._v(" E : "),r("code",[t._v("object")])]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("Struct")])]),t._v(" "),r("p",[r("strong",[t._v("↳ SubmittableResult")])]),t._v(" "),r("h1",{attrs:{id:"implements"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),r("ul",[r("li",[r("code",[t._v("Codec")])])]),t._v(" "),r("h1",{attrs:{id:"constructors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),r("p",[r("a",{attrs:{id:"constructor"}})]),t._v(" "),r("h2",{attrs:{id:"constructor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),r("p",[t._v("⊕ "),r("strong",[t._v("new SubmittableResult")]),t._v("(value?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableresult.html"}},[t._v("SubmittableResult")])],1),t._v(" "),r("p",[r("em",[t._v("Overrides Struct.__constructor")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:28"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" value")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableresult.html"}},[t._v("SubmittableResult")])],1),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"___tostringtag"}})]),t._v(" "),r("h2",{attrs:{id:"tostringtag"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostringtag","aria-hidden":"true"}},[t._v("#")]),t._v(" __@toStringTag")]),t._v(" "),r("p",[r("strong",[t._v("● __@toStringTag")]),t._v(": "),r("em",[r("code",[t._v("string")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.toStringTag]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"size"}})]),t._v(" "),r("h2",{attrs:{id:"size"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),r("p",[r("strong",[t._v("● size")]),t._v(": "),r("em",[r("code",[t._v("number")])])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.size")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"accessors"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" Type")]),t._v(" "),r("p",[r("strong",[t._v("get Type")]),t._v("(): "),r("code",[t._v("E")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.Type")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:160"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the Type description to sthe structure")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("E")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"encodedlength"}})]),t._v(" "),r("h2",{attrs:{id:"encodedlength"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#encodedlength","aria-hidden":"true"}},[t._v("#")]),t._v(" encodedLength")]),t._v(" "),r("p",[r("strong",[t._v("get encodedLength")]),t._v("(): "),r("code",[t._v("number")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.encodedLength")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:167"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": The length of the value when encoded as a Uint8Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("number")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"events"}})]),t._v(" "),r("h2",{attrs:{id:"events"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#events","aria-hidden":"true"}},[t._v("#")]),t._v(" events")]),t._v(" "),r("p",[r("strong",[t._v("get events")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("EventRecord")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the contained events")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("EventRecord")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"isempty"}})]),t._v(" "),r("h2",{attrs:{id:"isempty"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#isempty","aria-hidden":"true"}},[t._v("#")]),t._v(" isEmpty")]),t._v(" "),r("p",[r("strong",[t._v("get isEmpty")]),t._v("(): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.isEmpty")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:145"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Checks if the value is an empty value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"status"}})]),t._v(" "),r("h2",{attrs:{id:"status"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#status","aria-hidden":"true"}},[t._v("#")]),t._v(" status")]),t._v(" "),r("p",[r("strong",[t._v("get status")]),t._v("(): "),r("code",[t._v("ExtrinsicStatus")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:47"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the status")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("ExtrinsicStatus")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type-1"}})]),t._v(" "),r("h2",{attrs:{id:"type-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-2","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("get type")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/SubmittableExtrinsic.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("SubmittableExtrinsic.ts:54"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": the type")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"___iterator"}})]),t._v(" "),r("h2",{attrs:{id:"iterator"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#iterator","aria-hidden":"true"}},[t._v("#")]),t._v(" __@iterator")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("__@iterator")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.[Symbol.iterator]")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113")])]),t._v(" "),r("p",[t._v("Returns an iterable of entries in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"clear"}})]),t._v(" "),r("h2",{attrs:{id:"clear"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clear","aria-hidden":"true"}},[t._v("#")]),t._v(" clear")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("clear")]),t._v("(): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.clear")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22")])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"delete"}})]),t._v(" "),r("h2",{attrs:{id:"delete"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#delete","aria-hidden":"true"}},[t._v("#")]),t._v(" delete")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("delete")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.delete")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"entries"}})]),t._v(" "),r("h2",{attrs:{id:"entries"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#entries","aria-hidden":"true"}},[t._v("#")]),t._v(" entries")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("entries")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.entries")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118")])]),t._v(" "),r("p",[t._v("Returns an iterable of key, value pairs for every entry in the map.")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<["),r("code",[t._v("keyof S")]),t._v(", "),r("code",[t._v("Codec")]),t._v("]>")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"eq"}})]),t._v(" "),r("h2",{attrs:{id:"eq"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#eq","aria-hidden":"true"}},[t._v("#")]),t._v(" eq")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("eq")]),t._v("(other?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.eq")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:176"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Compares the value of the input to see if there is a match")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" other")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"foreach"}})]),t._v(" "),r("h2",{attrs:{id:"foreach"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#foreach","aria-hidden":"true"}},[t._v("#")]),t._v(" forEach")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("forEach")]),t._v("(callbackfn: "),r("em",[r("code",[t._v("function")])]),t._v(", thisArg?: "),r("em",[r("code",[t._v("any")])]),t._v("): "),r("code",[t._v("void")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.forEach")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("callbackfn")]),t._v(" "),r("td",[r("code",[t._v("function")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" thisArg")]),t._v(" "),r("td",[r("code",[t._v("any")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("void")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"get"}})]),t._v(" "),r("h2",{attrs:{id:"get"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#get","aria-hidden":"true"}},[t._v("#")]),t._v(" get")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("get")]),t._v("(name: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.get")])]),t._v(" "),r("p",[r("em",[t._v("Overrides Map.get")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:184"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a specific names entry in the structure")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("name")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])]),t._v(" "),r("td",[t._v("The name of the entry to retrieve")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Codec")]),t._v(" | "),r("code",[t._v("undefined")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"getatindex"}})]),t._v(" "),r("h2",{attrs:{id:"getatindex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#getatindex","aria-hidden":"true"}},[t._v("#")]),t._v(" getAtIndex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("getAtIndex")]),t._v("(index: "),r("em",[r("code",[t._v("number")])]),t._v("): "),r("code",[t._v("Codec")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.getAtIndex")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:191"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the values of a member at a specific index (Rather use get(name) for performance)")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("index")]),t._v(" "),r("td",[r("code",[t._v("number")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Codec")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"has"}})]),t._v(" "),r("h2",{attrs:{id:"has"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#has","aria-hidden":"true"}},[t._v("#")]),t._v(" has")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("has")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v("): "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.has")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("boolean")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"keys"}})]),t._v(" "),r("h2",{attrs:{id:"keys"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#keys","aria-hidden":"true"}},[t._v("#")]),t._v(" keys")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("keys")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.keys")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123")])]),t._v(" "),r("p",[t._v("Returns an iterable of keys in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("keyof S")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"set"}})]),t._v(" "),r("h2",{attrs:{id:"set"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#set","aria-hidden":"true"}},[t._v("#")]),t._v(" set")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("set")]),t._v("(key: "),r("em",[r("code",[t._v("keyof S")])]),t._v(", value: "),r("em",[r("code",[t._v("Codec")])]),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.set")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("key")]),t._v(" "),r("td",[r("code",[t._v("keyof S")])])]),t._v(" "),r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Codec")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"toarray"}})]),t._v(" "),r("h2",{attrs:{id:"toarray"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#toarray","aria-hidden":"true"}},[t._v("#")]),t._v(" toArray")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toArray")]),t._v("(): "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.toArray")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:198"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to an standard JavaScript Array")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tohex"}})]),t._v(" "),r("h2",{attrs:{id:"tohex"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tohex","aria-hidden":"true"}},[t._v("#")]),t._v(" toHex")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toHex")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.toHex")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:205"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns a hex string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tojson"}})]),t._v(" "),r("h2",{attrs:{id:"tojson"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toJSON")]),t._v("(): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.toJSON")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:212"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Converts the Object to JSON, typically used for RPC transfers")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tostring"}})]),t._v(" "),r("h2",{attrs:{id:"tostring"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tostring","aria-hidden":"true"}},[t._v("#")]),t._v(" toString")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toString")]),t._v("(): "),r("code",[t._v("string")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.toString")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:226"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Returns the string representation of the value")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("string")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"tou8a"}})]),t._v(" "),r("h2",{attrs:{id:"tou8a"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tou8a","aria-hidden":"true"}},[t._v("#")]),t._v(" toU8a")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("toU8a")]),t._v("(isBare?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.toU8a")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:234"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Encodes the value as a Uint8Array as per the parity-codec specifications")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Description")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" isBare")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v(" "),r("td",[t._v("true when the value has none of the type-specific prefixes (internal)")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Uint8Array")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"values"}})]),t._v(" "),r("h2",{attrs:{id:"values"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#values","aria-hidden":"true"}},[t._v("#")]),t._v(" values")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("values")]),t._v("(): "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Map.values")])]),t._v(" "),r("p",[r("em",[t._v("Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128")])]),t._v(" "),r("p",[t._v("Returns an iterable of values in the map")]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("IterableIterator")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"with"}})]),t._v(" "),r("h2",{attrs:{id:"static-with"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#static-with","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" with")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("with")]),t._v("<"),r("code",[t._v("S")]),t._v(">(Types: "),r("em",[r("code",[t._v("S")])]),t._v("): "),r("code",[t._v("Constructor")]),t._v("<"),r("code",[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")]),t._v(" "),r("p",[r("em",[t._v("Inherited from Struct.with")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:125"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("strong",[t._v("Type parameters:")])]),t._v(" "),r("h4",{attrs:{id:"s-constructordef-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#s-constructordef-2","aria-hidden":"true"}},[t._v("#")]),t._v(" S : "),r("code",[t._v("ConstructorDef")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("Types")]),t._v(" "),r("td",[r("code",[t._v("S")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Constructor")]),t._v("<"),r("code",[t._v("Struct")]),t._v("<"),r("code",[t._v("S")]),t._v(">>")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/5.45a9bb87.js b/docs/assets/js/5.45a9bb87.js deleted file mode 100644 index 375c3fa860..0000000000 --- a/docs/assets/js/5.45a9bb87.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[5],{334:function(e,t,r){"use strict";r.r(t);var s=r(46),a=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"contributing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#contributing","aria-hidden":"true"}},[e._v("#")]),e._v(" Contributing")]),e._v(" "),r("h2",{attrs:{id:"what"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#what","aria-hidden":"true"}},[e._v("#")]),e._v(" What?")]),e._v(" "),r("p",[e._v("Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit.\nA project is more like an open wiki than a standard guarded open source project.")]),e._v(" "),r("h2",{attrs:{id:"rules"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rules","aria-hidden":"true"}},[e._v("#")]),e._v(" Rules")]),e._v(" "),r("p",[e._v("There are a few basic ground-rules for contributors (including the maintainer(s) of the project):")]),e._v(" "),r("ol",[r("li",[r("strong",[e._v("No "),r("code",[e._v("--force")]),e._v(" pushes")]),e._v(" or modifying the Git history in any way. If you need to rebase, ensure you do it in your own repo.")]),e._v(" "),r("li",[r("strong",[e._v("Non-master branches")]),e._v(", prefixed with a short name moniker (e.g. "),r("code",[e._v("-")]),e._v(") must be used for ongoing work.")]),e._v(" "),r("li",[r("strong",[e._v("All modifications")]),e._v(" must be made in a "),r("strong",[e._v("pull-request")]),e._v(" to solicit feedback from other contributors.")]),e._v(" "),r("li",[e._v("A pull-request "),r("em",[e._v("must not be merged until CI")]),e._v(" has finished successfully.")])]),e._v(" "),r("h4",{attrs:{id:"merging-pull-requests-once-ci-is-successful"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#merging-pull-requests-once-ci-is-successful","aria-hidden":"true"}},[e._v("#")]),e._v(" Merging pull requests once CI is successful:")]),e._v(" "),r("ul",[r("li",[e._v("A pull request with no large change to logic that is an urgent fix may be merged after a non-author contributor has reviewed it well.")]),e._v(" "),r("li",[e._v("No PR should be merged until all reviews' comments are addressed.")])]),e._v(" "),r("h4",{attrs:{id:"reviewing-pull-requests"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reviewing-pull-requests","aria-hidden":"true"}},[e._v("#")]),e._v(" Reviewing pull requests:")]),e._v(" "),r("p",[e._v("When reviewing a pull request, the end-goal is to suggest useful changes to the author. Reviews should finish with approval unless there are issues that would result in:")]),e._v(" "),r("ul",[r("li",[e._v("Buggy behaviour.")]),e._v(" "),r("li",[e._v("Undue maintenance burden.")]),e._v(" "),r("li",[e._v("Breaking with house coding style.")]),e._v(" "),r("li",[e._v("Pessimisation (i.e. reduction of speed as measured in the projects benchmarks).")]),e._v(" "),r("li",[e._v("Feature reduction (i.e. it removes some aspect of functionality that a significant minority of users rely on).")]),e._v(" "),r("li",[e._v("Uselessness (i.e. it does not strictly add a feature or fix a known issue).")])]),e._v(" "),r("h4",{attrs:{id:"reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#reviews-may-not-be-used-as-an-effective-veto-for-a-pr-because","aria-hidden":"true"}},[e._v("#")]),e._v(" Reviews may not be used as an effective veto for a PR because:")]),e._v(" "),r("ul",[r("li",[e._v("There exists a somewhat cleaner/better/faster way of accomplishing the same feature/fix.")]),e._v(" "),r("li",[e._v("It does not fit well with some other contributors' longer-term vision for the project.")])]),e._v(" "),r("h2",{attrs:{id:"releases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#releases","aria-hidden":"true"}},[e._v("#")]),e._v(" Releases")]),e._v(" "),r("p",[e._v("Declaring formal releases remains the prerogative of the project maintainer(s).")]),e._v(" "),r("h2",{attrs:{id:"changes-to-this-arrangement"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#changes-to-this-arrangement","aria-hidden":"true"}},[e._v("#")]),e._v(" Changes to this arrangement")]),e._v(" "),r("p",[e._v("This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.")]),e._v(" "),r("h2",{attrs:{id:"heritage"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#heritage","aria-hidden":"true"}},[e._v("#")]),e._v(" Heritage")]),e._v(" "),r("p",[e._v('These contributing guidelines are modified from the "OPEN Open Source Project" guidelines for the Level project: '),r("a",{attrs:{href:"https://github.com/Level/community/blob/master/CONTRIBUTING.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://github.com/Level/community/blob/master/CONTRIBUTING.md"),r("OutboundLink")],1)])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/50.5fe10ce8.js b/docs/assets/js/50.5fe10ce8.js deleted file mode 100644 index 3f4aec3bb4..0000000000 --- a/docs/assets/js/50.5fe10ce8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[50],{706:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("p",[e("strong",[t._v("↳ ApiPromiseInterface")])]),t._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),e("h1",{attrs:{id:"implemented-by"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1)]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new ApiPromiseInterface")]),t._v("(provider?: "),e("em",[e("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),e("code",[t._v("ProviderInterface")])],1),t._v(", type: "),e("em",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v("): "),e("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:81"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Create an instance of the class")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Api")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("isReady")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token template-string"}},[e("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),e("span",{pre:!0,attrs:{class:"token interpolation"}},[e("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" provider")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),e("code",[t._v("ProviderInterface")])],1),t._v(" "),e("td",[t._v("{}")])]),t._v(" "),e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"isready"}})]),t._v(" "),e("h2",{attrs:{id:"isready"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isready","aria-hidden":"true"}},[t._v("#")]),t._v(" isReady")]),t._v(" "),e("p",[e("strong",[t._v("● isReady")]),t._v(": "),e("em",[e("code",[t._v("Promise")]),t._v("<"),e("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")]),t._v(">")],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/types.ts:16"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"accessors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),e("p",[e("a",{attrs:{id:"derive"}})]),t._v(" "),e("h2",{attrs:{id:"derive"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[t._v("#")]),t._v(" derive")]),t._v(" "),e("p",[e("strong",[t._v("get derive")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#derive"}},[t._v("derive")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:196"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Derived results that are injected into the API, allowing for combinations of various query results.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'best number'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"genesishash"}})]),t._v(" "),e("h2",{attrs:{id:"genesishash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[t._v("#")]),t._v(" genesisHash")]),t._v(" "),e("p",[e("strong",[t._v("get genesisHash")]),t._v("(): "),e("code",[t._v("Hash")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#genesishash"}},[t._v("genesisHash")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:132"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Hash")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),e("h2",{attrs:{id:"hassubscriptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),e("p",[e("strong",[t._v("get hasSubscriptions")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#hassubscriptions"}},[t._v("hasSubscriptions")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:141"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("true")]),t._v(" when subscriptions are supported")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("boolean")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"libraryinfo"}})]),t._v(" "),e("h2",{attrs:{id:"libraryinfo"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#libraryinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" libraryInfo")]),t._v(" "),e("p",[e("strong",[t._v("get libraryInfo")]),t._v("(): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#libraryinfo"}},[t._v("libraryInfo")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:148"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The library information name & version (from package.json)")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"query"}})]),t._v(" "),e("h2",{attrs:{id:"query"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[t._v("#")]),t._v(" query")]),t._v(" "),e("p",[e("strong",[t._v("get query")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#query"}},[t._v("query")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:216"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.")]),t._v(" "),e("p",[t._v("All calls inside the namespace, is denoted by "),e("code",[t._v("section")]),t._v("."),e("code",[t._v("method")]),t._v(" and may take an optional query parameter. As an example, "),e("code",[t._v("api.query.timestamp.now()")]),t._v(" (current block timestamp) does not take parameters, while "),e("code",[t._v("api.query.system.accountNonce()")]),t._v(" (retrieving the associated nonce for an account), takes the "),e("code",[t._v("AccountId")]),t._v(" as a parameter.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("accountId"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new balance'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"rpc"}})]),t._v(" "),e("h2",{attrs:{id:"rpc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[t._v("#")]),t._v(" rpc")]),t._v(" "),e("p",[e("strong",[t._v("get rpc")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#rpc"}},[t._v("rpc")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:236"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic "),e("code",[t._v("api.query")]),t._v(" and "),e("code",[t._v("api.tx")]),t._v(" sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.")]),t._v(" "),e("p",[t._v("RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new header'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"runtimemetadata"}})]),t._v(" "),e("h2",{attrs:{id:"runtimemetadata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeMetadata")]),t._v(" "),e("p",[e("strong",[t._v("get runtimeMetadata")]),t._v("(): "),e("code",[t._v("Metadata")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimemetadata"}},[t._v("runtimeMetadata")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:155"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Metadata")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"runtimeversion"}})]),t._v(" "),e("h2",{attrs:{id:"runtimeversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeVersion")]),t._v(" "),e("p",[e("strong",[t._v("get runtimeVersion")]),t._v("(): "),e("code",[t._v("RuntimeVersion")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimeversion"}},[t._v("runtimeVersion")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:164"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains the version information for the current runtime.")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("RuntimeVersion")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"tx"}})]),t._v(" "),e("h2",{attrs:{id:"tx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[t._v("#")]),t._v(" tx")]),t._v(" "),e("p",[e("strong",[t._v("get tx")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#tx"}},[t._v("tx")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:254"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("recipientId"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("balance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("keyPair"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("status"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'tx status'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"type"}})]),t._v(" "),e("h2",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[e("strong",[t._v("get type")]),t._v("(): "),e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#type"}},[t._v("type")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:173"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The type of this API instance, either 'rxjs' or 'promise'")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("p",[e("a",{attrs:{id:"disconnect"}})]),t._v(" "),e("h2",{attrs:{id:"disconnect"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("disconnect")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:263"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Disconnect from the underlying provider, halting all comms")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"on"}})]),t._v(" "),e("h2",{attrs:{id:"on"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("on")]),t._v("(type: "),e("em",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),e("em",[e("code",[t._v("function")])]),t._v("): "),e("code",[t._v("this")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#on"}},[t._v("on")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:286"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Attach an eventemitter handler to listen to a specific event")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),e("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),e("tr",[e("td",[t._v("handler")]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("this")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"once"}})]),t._v(" "),e("h2",{attrs:{id:"once"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("once")]),t._v("(type: "),e("em",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),e("em",[e("code",[t._v("function")])]),t._v("): "),e("code",[t._v("this")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#once"}},[t._v("once")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:311"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Attach an one-time eventemitter handler to listen to a specific event")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),e("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),e("tr",[e("td",[t._v("handler")]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("this")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"registertypes"}})]),t._v(" "),e("h2",{attrs:{id:"registertypes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registertypes","aria-hidden":"true"}},[t._v("#")]),t._v(" registerTypes")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("registerTypes")]),t._v("(types?: "),e("em",[e("code",[t._v("RegistryTypes")])]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:320"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Register additional user-defined of chain-specific types in the type registry")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" types")]),t._v(" "),e("td",[e("code",[t._v("RegistryTypes")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"setsigner"}})]),t._v(" "),e("h2",{attrs:{id:"setsigner"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setsigner","aria-hidden":"true"}},[t._v("#")]),t._v(" setSigner")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setSigner")]),t._v("(signer: "),e("em",[e("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:180"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("signer")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1)])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/51.02b977ea.js b/docs/assets/js/51.02b977ea.js deleted file mode 100644 index f9e289b019..0000000000 --- a/docs/assets/js/51.02b977ea.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[51],{703:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("p",[e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("p",[e("strong",[t._v("↳ ApiRxInterface")])]),t._v(" "),e("h1",{attrs:{id:"implements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implements","aria-hidden":"true"}},[t._v("#")]),t._v(" Implements")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1)]),t._v(" "),e("h1",{attrs:{id:"implemented-by"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1)]),t._v(" "),e("h1",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors","aria-hidden":"true"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("p",[e("a",{attrs:{id:"constructor"}})]),t._v(" "),e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor","aria-hidden":"true"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("⊕ "),e("strong",[t._v("new ApiRxInterface")]),t._v("(provider?: "),e("em",[e("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),e("code",[t._v("ProviderInterface")])],1),t._v(", type: "),e("em",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v("): "),e("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#constructor"}},[t._v("constructor")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:81"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Create an instance of the class")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Api "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api/promise'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Api")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("isReady")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token template-string"}},[e("span",{pre:!0,attrs:{class:"token string"}},[t._v("`new block #")]),e("span",{pre:!0,attrs:{class:"token interpolation"}},[e("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default value")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Default value")]),t._v(" provider")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")]),t._v(" | "),e("code",[t._v("ProviderInterface")])],1),t._v(" "),e("td",[t._v("{}")])]),t._v(" "),e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),e("td",[t._v("-")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("p",[e("a",{attrs:{id:"isconnected"}})]),t._v(" "),e("h2",{attrs:{id:"isconnected"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isconnected","aria-hidden":"true"}},[t._v("#")]),t._v(" isConnected")]),t._v(" "),e("p",[e("strong",[t._v("● isConnected")]),t._v(": "),e("em",[e("code",[t._v("Observable")]),t._v("<"),e("code",[t._v("boolean")]),t._v(">")])]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/types.ts:13"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"isready"}})]),t._v(" "),e("h2",{attrs:{id:"isready"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isready","aria-hidden":"true"}},[t._v("#")]),t._v(" isReady")]),t._v(" "),e("p",[e("strong",[t._v("● isReady")]),t._v(": "),e("em",[e("code",[t._v("Observable")]),t._v("<"),e("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")]),t._v(">")],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/types.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("rx/types.ts:14"),e("OutboundLink")],1)])]),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"accessors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#accessors","aria-hidden":"true"}},[t._v("#")]),t._v(" Accessors")]),t._v(" "),e("p",[e("a",{attrs:{id:"derive"}})]),t._v(" "),e("h2",{attrs:{id:"derive"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[t._v("#")]),t._v(" derive")]),t._v(" "),e("p",[e("strong",[t._v("get derive")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#derive"}},[t._v("derive")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L196",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:196"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Derived results that are injected into the API, allowing for combinations of various query results.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("derive"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("bestNumber")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'best number'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"genesishash"}})]),t._v(" "),e("h2",{attrs:{id:"genesishash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[t._v("#")]),t._v(" genesisHash")]),t._v(" "),e("p",[e("strong",[t._v("get genesisHash")]),t._v("(): "),e("code",[t._v("Hash")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#genesishash"}},[t._v("genesisHash")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L132",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:132"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains the genesis Hash of the attached chain. Apart from being useful to determine the actual chain, it can also be used to sign immortal transactions.")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Hash")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"hassubscriptions"}})]),t._v(" "),e("h2",{attrs:{id:"hassubscriptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[t._v("#")]),t._v(" hasSubscriptions")]),t._v(" "),e("p",[e("strong",[t._v("get hasSubscriptions")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#hassubscriptions"}},[t._v("hasSubscriptions")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:141"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": "),e("code",[t._v("true")]),t._v(" when subscriptions are supported")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("boolean")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"libraryinfo"}})]),t._v(" "),e("h2",{attrs:{id:"libraryinfo"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#libraryinfo","aria-hidden":"true"}},[t._v("#")]),t._v(" libraryInfo")]),t._v(" "),e("p",[e("strong",[t._v("get libraryInfo")]),t._v("(): "),e("code",[t._v("string")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#libraryinfo"}},[t._v("libraryInfo")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L148",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:148"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The library information name & version (from package.json)")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("string")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"query"}})]),t._v(" "),e("h2",{attrs:{id:"query"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[t._v("#")]),t._v(" query")]),t._v(" "),e("p",[e("strong",[t._v("get query")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#query"}},[t._v("query")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L216",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:216"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains all the chain state modules and their subsequent methods in the API. These are attached dynamically from the runtime metadata.")]),t._v(" "),e("p",[t._v("All calls inside the namespace, is denoted by "),e("code",[t._v("section")]),t._v("."),e("code",[t._v("method")]),t._v(" and may take an optional query parameter. As an example, "),e("code",[t._v("api.query.timestamp.now()")]),t._v(" (current block timestamp) does not take parameters, while "),e("code",[t._v("api.query.system.accountNonce()")]),t._v(" (retrieving the associated nonce for an account), takes the "),e("code",[t._v("AccountId")]),t._v(" as a parameter.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("accountId"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("balance"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new balance'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" balance"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"rpc"}})]),t._v(" "),e("h2",{attrs:{id:"rpc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[t._v("#")]),t._v(" rpc")]),t._v(" "),e("p",[e("strong",[t._v("get rpc")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#rpc"}},[t._v("rpc")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L236",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:236"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains all the raw rpc sections and their subsequent methods in the API as defined by the jsonrpc interface definitions. Unlike the dynamic "),e("code",[t._v("api.query")]),t._v(" and "),e("code",[t._v("api.tx")]),t._v(" sections, these methods are fixed (although extensible with node upgrades) and not determined by the runtime.")]),t._v(" "),e("p",[t._v("RPC endpoints available here allow for the query of chain, node and system information, in addition to providing interfaces for the raw queries of state (usine known keys) and the submission of transactions.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new header'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" header"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"runtimemetadata"}})]),t._v(" "),e("h2",{attrs:{id:"runtimemetadata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeMetadata")]),t._v(" "),e("p",[e("strong",[t._v("get runtimeMetadata")]),t._v("(): "),e("code",[t._v("Metadata")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimemetadata"}},[t._v("runtimeMetadata")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L155",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:155"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Yields the current attached runtime metadata. Generally this is only used to construct extrinsics & storage, but is useful for current runtime inspection.")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("Metadata")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"runtimeversion"}})]),t._v(" "),e("h2",{attrs:{id:"runtimeversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[t._v("#")]),t._v(" runtimeVersion")]),t._v(" "),e("p",[e("strong",[t._v("get runtimeVersion")]),t._v("(): "),e("code",[t._v("RuntimeVersion")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#runtimeversion"}},[t._v("runtimeVersion")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L164",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:164"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains the version information for the current runtime.")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("RuntimeVersion")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"tx"}})]),t._v(" "),e("h2",{attrs:{id:"tx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[t._v("#")]),t._v(" tx")]),t._v(" "),e("p",[e("strong",[t._v("get tx")]),t._v("(): "),e("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#tx"}},[t._v("tx")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L254",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:254"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Contains all the extrinsic modules and their subsequent methods in the API. It allows for the construction of transactions and the submission thereof. These are attached dynamically from the runtime metadata.")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("recipientId"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("balance"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("keyPair"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("status"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'tx status'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br")])]),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")]),t._v("<"),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),e("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"type"}})]),t._v(" "),e("h2",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[e("strong",[t._v("get type")]),t._v("(): "),e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#type"}},[t._v("type")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L173",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:173"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": The type of this API instance, either 'rxjs' or 'promise'")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),e("hr"),t._v(" "),e("h1",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("p",[e("a",{attrs:{id:"disconnect"}})]),t._v(" "),e("h2",{attrs:{id:"disconnect"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#disconnect","aria-hidden":"true"}},[t._v("#")]),t._v(" disconnect")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("disconnect")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#disconnect"}},[t._v("disconnect")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L263",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:263"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Disconnect from the underlying provider, halting all comms")]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"on"}})]),t._v(" "),e("h2",{attrs:{id:"on"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("on")]),t._v("(type: "),e("em",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),e("em",[e("code",[t._v("function")])]),t._v("): "),e("code",[t._v("this")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#on"}},[t._v("on")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L286",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:286"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Attach an eventemitter handler to listen to a specific event")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("on")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),e("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),e("tr",[e("td",[t._v("handler")]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("this")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"once"}})]),t._v(" "),e("h2",{attrs:{id:"once"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("once")]),t._v("(type: "),e("em",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),e("em",[e("code",[t._v("function")])]),t._v("): "),e("code",[t._v("this")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#once"}},[t._v("once")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L311",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:311"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Attach an one-time eventemitter handler to listen to a specific event")]),t._v(" "),e("p",[e("em",[e("strong",[t._v("example")])]),t._v(":")]),t._v(" "),e("div",{staticClass:"language-javascript line-numbers-mode"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("api"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'connected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been connected to the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\napi"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("once")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'disconnected'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'API has been disconnected from the endpoint'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),e("div",{staticClass:"line-numbers-wrapper"},[e("span",{staticClass:"line-number"},[t._v("1")]),e("br"),e("span",{staticClass:"line-number"},[t._v("2")]),e("br"),e("span",{staticClass:"line-number"},[t._v("3")]),e("br"),e("span",{staticClass:"line-number"},[t._v("4")]),e("br"),e("span",{staticClass:"line-number"},[t._v("5")]),e("br"),e("span",{staticClass:"line-number"},[t._v("6")]),e("br"),e("span",{staticClass:"line-number"},[t._v("7")]),e("br")])]),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("type")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),e("td",[t._v("The type of event to listen to. Available events are `connected`, `disconnected`, `ready` and `error`")])]),t._v(" "),e("tr",[e("td",[t._v("handler")]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[t._v("The callback to be called when the event fires. Depending on the event type, it could fire with additional arguments.")])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("this")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"registertypes"}})]),t._v(" "),e("h2",{attrs:{id:"registertypes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registertypes","aria-hidden":"true"}},[t._v("#")]),t._v(" registerTypes")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("registerTypes")]),t._v("(types?: "),e("em",[e("code",[t._v("RegistryTypes")])]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#registertypes"}},[t._v("registerTypes")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L320",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:320"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Register additional user-defined of chain-specific types in the type registry")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("Optional")]),t._v(" types")]),t._v(" "),e("td",[e("code",[t._v("RegistryTypes")])])])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr"),t._v(" "),e("p",[e("a",{attrs:{id:"setsigner"}})]),t._v(" "),e("h2",{attrs:{id:"setsigner"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setsigner","aria-hidden":"true"}},[t._v("#")]),t._v(" setSigner")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setSigner")]),t._v("(signer: "),e("em",[e("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("em",[t._v("Inherited from "),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")]),t._v("."),e("router-link",{attrs:{to:"/api/classes/_base_.apibase.html#setsigner"}},[t._v("setSigner")])],1)]),t._v(" "),e("p",[e("em",[t._v("Defined in "),e("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/Base.ts#L180",target:"_blank",rel:"noopener noreferrer"}},[t._v("Base.ts:180"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("em",[e("strong",[t._v("description")])]),t._v(": Set an external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),t._v(" "),e("p",[e("strong",[t._v("Parameters:")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("signer")]),t._v(" "),e("td",[e("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1)])])]),t._v(" "),e("p",[e("strong",[t._v("Returns:")]),t._v(" "),e("code",[t._v("void")])]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/52.55f294e3.js b/docs/assets/js/52.55f294e3.js deleted file mode 100644 index cb029893ff..0000000000 --- a/docs/assets/js/52.55f294e3.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{483:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("code",[t._v("object")])]),t._v(" "),r("p",[r("strong",[t._v("↳ ApiBaseInterface")])]),t._v(" "),r("h1",{attrs:{id:"implemented-by"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#implemented-by","aria-hidden":"true"}},[t._v("#")]),t._v(" Implemented by")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[t._v("ApiRxInterface")])],1)]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"on"}})]),t._v(" "),r("h2",{attrs:{id:"on"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#on","aria-hidden":"true"}},[t._v("#")]),t._v(" on")]),t._v(" "),r("p",[r("strong",[t._v("● on")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L158",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:158"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(type: "),r("em",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1)]),t._v(" "),r("tr",[r("td",[t._v("handler")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"once"}})]),t._v(" "),r("h2",{attrs:{id:"once"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#once","aria-hidden":"true"}},[t._v("#")]),t._v(" once")]),t._v(" "),r("p",[r("strong",[t._v("● once")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L159",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:159"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(type: "),r("em",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(", handler: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("code",[t._v("this")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("type")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1)]),t._v(" "),r("tr",[r("td",[t._v("handler")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("this")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"type"}})]),t._v(" "),r("h2",{attrs:{id:"type"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type","aria-hidden":"true"}},[t._v("#")]),t._v(" type")]),t._v(" "),r("p",[r("strong",[t._v("● type")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:156"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/53.49b9b3f7.js b/docs/assets/js/53.49b9b3f7.js deleted file mode 100644 index e65358b1a5..0000000000 --- a/docs/assets/js/53.49b9b3f7.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{486:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("ApiInterface$Decorated")])]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"derive"}})]),e._v(" "),r("h2",{attrs:{id:"derive"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#derive","aria-hidden":"true"}},[e._v("#")]),e._v(" derive")]),e._v(" "),r("p",[r("strong",[e._v("● derive")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[e._v("Derive")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L142",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:142"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"genesishash"}})]),e._v(" "),r("h2",{attrs:{id:"genesishash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#genesishash","aria-hidden":"true"}},[e._v("#")]),e._v(" genesisHash")]),e._v(" "),r("p",[r("strong",[e._v("● genesisHash")]),e._v(": "),r("em",[r("code",[e._v("Hash")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L138",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:138"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"hassubscriptions"}})]),e._v(" "),r("h2",{attrs:{id:"hassubscriptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hassubscriptions","aria-hidden":"true"}},[e._v("#")]),e._v(" hasSubscriptions")]),e._v(" "),r("p",[r("strong",[e._v("● hasSubscriptions")]),e._v(": "),r("em",[r("code",[e._v("boolean")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L139",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:139"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"query"}})]),e._v(" "),r("h2",{attrs:{id:"query"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#query","aria-hidden":"true"}},[e._v("#")]),e._v(" query")]),e._v(" "),r("p",[r("strong",[e._v("● query")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[e._v("QueryableStorage")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L143",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:143"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"rpc"}})]),e._v(" "),r("h2",{attrs:{id:"rpc"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rpc","aria-hidden":"true"}},[e._v("#")]),e._v(" rpc")]),e._v(" "),r("p",[r("strong",[e._v("● rpc")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[e._v("DecoratedRpc")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L144",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:144"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"runtimemetadata"}})]),e._v(" "),r("h2",{attrs:{id:"runtimemetadata"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#runtimemetadata","aria-hidden":"true"}},[e._v("#")]),e._v(" runtimeMetadata")]),e._v(" "),r("p",[r("strong",[e._v("● runtimeMetadata")]),e._v(": "),r("em",[r("code",[e._v("Metadata")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:140"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"runtimeversion"}})]),e._v(" "),r("h2",{attrs:{id:"runtimeversion"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#runtimeversion","aria-hidden":"true"}},[e._v("#")]),e._v(" runtimeVersion")]),e._v(" "),r("p",[r("strong",[e._v("● runtimeVersion")]),e._v(": "),r("em",[r("code",[e._v("RuntimeVersion")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L141",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:141"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"signer"}})]),e._v(" "),r("h2",{attrs:{id:"optional-signer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-signer","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" signer")]),e._v(" "),r("p",[r("strong",[e._v("● signer")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[e._v("Signer")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L146",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:146"),r("OutboundLink")],1)])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"tx"}})]),e._v(" "),r("h2",{attrs:{id:"tx"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tx","aria-hidden":"true"}},[e._v("#")]),e._v(" tx")]),e._v(" "),r("p",[r("strong",[e._v("● tx")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[e._v("SubmittableExtrinsics")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L145",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:145"),r("OutboundLink")],1)])]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/54.4b6f6495.js b/docs/assets/js/54.4b6f6495.js deleted file mode 100644 index 90c29bfdd9..0000000000 --- a/docs/assets/js/54.4b6f6495.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{484:function(e,t,r){"use strict";r.r(t);var s=r(46),a=Object(s.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("ApiOptions")])]),e._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("p",[r("a",{attrs:{id:"derives"}})]),e._v(" "),r("h2",{attrs:{id:"optional-derives"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-derives","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" derives")]),e._v(" "),r("p",[r("strong",[e._v("● derives")]),e._v(": "),r("em",[r("code",[e._v("DeriveCustom")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L116",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:116"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Add custom derives to be injected")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"provider"}})]),e._v(" "),r("h2",{attrs:{id:"optional-provider"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-provider","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" provider")]),e._v(" "),r("p",[r("strong",[e._v("● provider")]),e._v(": "),r("em",[r("code",[e._v("ProviderInterface")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L121",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:121"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Transport Provider from rpc-provider. If not specified, it will default to connecting to a WsProvider connecting localhost with the default port, i.e. "),r("code",[e._v("ws://127.0.0.1:9944")])]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"signer"}})]),e._v(" "),r("h2",{attrs:{id:"optional-signer"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-signer","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" signer")]),e._v(" "),r("p",[r("strong",[e._v("● signer")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[e._v("Signer")])],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L125",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:125"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": An external signer which will be used to sign extrinsic when account passed in is not KeyringPair")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"source"}})]),e._v(" "),r("h2",{attrs:{id:"optional-source"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-source","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" source")]),e._v(" "),r("p",[r("strong",[e._v("● source")]),e._v(": "),r("em",[r("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[e._v("ApiBase")]),e._v("<"),r("code",[e._v("any")]),e._v(", "),r("code",[e._v("any")]),e._v(">")],1)]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:129"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": The source object to use for runtime information (only used when cloning)")]),e._v(" "),r("hr"),e._v(" "),r("p",[r("a",{attrs:{id:"types"}})]),e._v(" "),r("h2",{attrs:{id:"optional-types"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-types","aria-hidden":"true"}},[e._v("#")]),e._v(" "),r("code",[e._v("")]),e._v(" types")]),e._v(" "),r("p",[r("strong",[e._v("● types")]),e._v(": "),r("em",[r("code",[e._v("RegistryTypes")])])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L134",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:134"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("em",[r("strong",[e._v("description")])]),e._v(": Additional types used by runtime modules. This is nessusary if the runtime modules uses types not available in the base Substrate runtime.")]),e._v(" "),r("hr")])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/55.0768babe.js b/docs/assets/js/55.0768babe.js deleted file mode 100644 index aac3567bab..0000000000 --- a/docs/assets/js/55.0768babe.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{388:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("DecoratedRpc")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"author"}})]),t._v(" "),r("h2",{attrs:{id:"author"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#author","aria-hidden":"true"}},[t._v("#")]),t._v(" author")]),t._v(" "),r("p",[r("strong",[t._v("● author")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_section.html"}},[t._v("DecoratedRpc$Section")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:34"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"chain"}})]),t._v(" "),r("h2",{attrs:{id:"chain"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#chain","aria-hidden":"true"}},[t._v("#")]),t._v(" chain")]),t._v(" "),r("p",[r("strong",[t._v("● chain")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_section.html"}},[t._v("DecoratedRpc$Section")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L35",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:35"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"state"}})]),t._v(" "),r("h2",{attrs:{id:"state"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#state","aria-hidden":"true"}},[t._v("#")]),t._v(" state")]),t._v(" "),r("p",[r("strong",[t._v("● state")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_section.html"}},[t._v("DecoratedRpc$Section")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:36"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"system"}})]),t._v(" "),r("h2",{attrs:{id:"system"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#system","aria-hidden":"true"}},[t._v("#")]),t._v(" system")]),t._v(" "),r("p",[r("strong",[t._v("● system")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_section.html"}},[t._v("DecoratedRpc$Section")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:37"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/56.a6db3bce.js b/docs/assets/js/56.a6db3bce.js deleted file mode 100644 index 81d9910780..0000000000 --- a/docs/assets/js/56.a6db3bce.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[56],{390:function(e,t,a){"use strict";a.r(t);var r=a(46),_=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"type-parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),a("h4",{attrs:{id:"codecresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),a("h4",{attrs:{id:"subscriptionresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),a("p",[a("strong",[e._v("DecoratedRpc$Method")])]),e._v(" "),a("h1",{attrs:{id:"callable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#callable","aria-hidden":"true"}},[e._v("#")]),e._v(" Callable")]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("__call")]),e._v("(callback: "),a("em",[a("code",[e._v("CodecCallback")])]),e._v("): "),a("code",[e._v("SubscriptionResult")])]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("__call")]),e._v("(arg1: "),a("em",[a("code",[e._v("CodecArg")])]),e._v(", callback: "),a("em",[a("code",[e._v("CodecCallback")])]),e._v("): "),a("code",[e._v("SubscriptionResult")])]),e._v(" "),a("p",[e._v("▸ "),a("strong",[e._v("__call")]),e._v("(arg1?: "),a("em",[a("code",[e._v("CodecArg")])]),e._v(", arg2?: "),a("em",[a("code",[e._v("CodecArg")])]),e._v(", arg3?: "),a("em",[a("code",[e._v("CodecArg")])]),e._v("): "),a("code",[e._v("CodecResult")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:23"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("callback")]),e._v(" "),a("td",[a("code",[e._v("CodecCallback")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("SubscriptionResult")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:24"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[e._v("arg1")]),e._v(" "),a("td",[a("code",[e._v("CodecArg")])])]),e._v(" "),a("tr",[a("td",[e._v("callback")]),e._v(" "),a("td",[a("code",[e._v("CodecCallback")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("SubscriptionResult")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:25"),a("OutboundLink")],1)])]),e._v(" "),a("p",[a("strong",[e._v("Parameters:")])]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Name")]),e._v(" "),a("th",[e._v("Type")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[a("code",[e._v("Optional")]),e._v(" arg1")]),e._v(" "),a("td",[a("code",[e._v("CodecArg")])])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("Optional")]),e._v(" arg2")]),e._v(" "),a("td",[a("code",[e._v("CodecArg")])])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("Optional")]),e._v(" arg3")]),e._v(" "),a("td",[a("code",[e._v("CodecArg")])])])])]),e._v(" "),a("p",[a("strong",[e._v("Returns:")]),e._v(" "),a("code",[e._v("CodecResult")])])])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/57.8437eb37.js b/docs/assets/js/57.8437eb37.js deleted file mode 100644 index 64e164ebb9..0000000000 --- a/docs/assets/js/57.8437eb37.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{391:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("DecoratedRpc$Section")])]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("string")]),e._v("]: "),r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_method.html"}},[e._v("DecoratedRpc$Method")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/58.fa6e99dd.js b/docs/assets/js/58.fa6e99dd.js deleted file mode 100644 index 40b22ceb9e..0000000000 --- a/docs/assets/js/58.fa6e99dd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{393:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("Derive")])]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("string")]),e._v("]: "),r("router-link",{attrs:{to:"/api/interfaces/_types_.derivesection.html"}},[e._v("DeriveSection")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/59.09d0c438.js b/docs/assets/js/59.09d0c438.js deleted file mode 100644 index f694675a38..0000000000 --- a/docs/assets/js/59.09d0c438.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{394:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("DeriveMethodBase")])]),e._v(" "),r("h1",{attrs:{id:"callable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#callable","aria-hidden":"true"}},[e._v("#")]),e._v(" Callable")]),e._v(" "),r("p",[e._v("▸ "),r("strong",[e._v("__call")]),e._v("(...params: "),r("em",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("CodecArg")]),e._v(">")]),e._v("): "),r("code",[e._v("CodecResult")])]),e._v(" "),r("p",[r("em",[e._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[e._v("types.ts:88"),r("OutboundLink")],1)])]),e._v(" "),r("p",[r("strong",[e._v("Parameters:")])]),e._v(" "),r("table",[r("thead",[r("tr",[r("th",[e._v("Name")]),e._v(" "),r("th",[e._v("Type")])])]),e._v(" "),r("tbody",[r("tr",[r("td",[r("code",[e._v("Rest")]),e._v(" params")]),e._v(" "),r("td",[r("code",[e._v("Array")]),e._v("<"),r("code",[e._v("CodecArg")]),e._v(">")])])])]),e._v(" "),r("p",[r("strong",[e._v("Returns:")]),e._v(" "),r("code",[e._v("CodecResult")])])])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/6.faddde38.js b/docs/assets/js/6.faddde38.js deleted file mode 100644 index e7b201e02f..0000000000 --- a/docs/assets/js/6.faddde38.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[6],{336:function(e,v,_){"use strict";_.r(v);var t=_(46),s=Object(t.a)({},function(){var e=this,v=e.$createElement,_=e._self._c||v;return _("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[_("h2",{attrs:{id:"events"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#events","aria-hidden":"true"}},[e._v("#")]),e._v(" Events")]),e._v(" "),_("p",[e._v("Events are emitted for certain operations on the runtime. The following sections describe the events that are part of the default Substrate runtime.")]),e._v(" "),_("ul",[_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#balances"}},[e._v("balances")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#contract"}},[e._v("contract")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#council"}},[e._v("council")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#councilMotions"}},[e._v("councilMotions")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#councilVoting"}},[e._v("councilVoting")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#democracy"}},[e._v("democracy")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#fees"}},[e._v("fees")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#grandpa"}},[e._v("grandpa")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#indices"}},[e._v("indices")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#session"}},[e._v("session")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#staking"}},[e._v("staking")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#sudo"}},[e._v("sudo")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#system"}},[e._v("system")])])])]),e._v(" "),_("li",[_("p",[_("strong",[_("a",{attrs:{href:"#treasury"}},[e._v("treasury")])])])])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"balances"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#balances","aria-hidden":"true"}},[e._v("#")]),e._v(" balances")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("NewAccount")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A new account was created.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ReapedAccount")]),e._v("("),_("code",[e._v("AccountId")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": An account was reaped.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Transfer")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("Balance")]),e._v(", "),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Transfer succeeded (from, to, value, fees).")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"contract"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#contract","aria-hidden":"true"}},[e._v("#")]),e._v(" contract")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("CodeStored")]),e._v("("),_("code",[e._v("Hash")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Code with the specified hash has been stored.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Dispatched")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("bool")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A call was dispatched from the given account. The bool signals whether it was successful execution or not.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Instantiated")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("AccountId")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Contract deployed by address at the specified address.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ScheduleUpdated")]),e._v("("),_("code",[e._v("u32")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Triggered when the current schedule is updated.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Transfer")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Transfer happened "),_("code",[e._v("from")]),e._v(" -> "),_("code",[e._v("to")]),e._v(" with given "),_("code",[e._v("value")]),e._v(" as part of a "),_("code",[e._v("message-call")]),e._v(" or "),_("code",[e._v("create")]),e._v(".")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"council"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#council","aria-hidden":"true"}},[e._v("#")]),e._v(" council")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("BadReaperSlashed")]),e._v("("),_("code",[e._v("AccountId")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": slashed reaper")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("TallyFinalised")]),e._v("("),_("code",[e._v("Vec")]),e._v(", "),_("code",[e._v("Vec")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A tally (for approval votes of council seat(s)) has ended (with one or more new members).")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("TallyStarted")]),e._v("("),_("code",[e._v("u32")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A tally (for approval votes of council seat(s)) has started.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("VoterReaped")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("AccountId")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": reaped voter, reaper")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"councilmotions"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#councilmotions","aria-hidden":"true"}},[e._v("#")]),e._v(" councilMotions")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Approved")]),e._v("("),_("code",[e._v("Hash")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A motion was approved by the required threshold.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Disapproved")]),e._v("("),_("code",[e._v("Hash")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A motion was not approved by the required threshold.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Executed")]),e._v("("),_("code",[e._v("Hash")]),e._v(", "),_("code",[e._v("bool")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A motion was executed; "),_("code",[e._v("bool")]),e._v(" is true if returned without error.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Proposed")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("ProposalIndex")]),e._v(", "),_("code",[e._v("Hash")]),e._v(", "),_("code",[e._v("u32")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A motion (given hash) has been proposed (by given account) with a threshold (given u32).")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Voted")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("Hash")]),e._v(", "),_("code",[e._v("bool")]),e._v(", "),_("code",[e._v("u32")]),e._v(", "),_("code",[e._v("u32")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A motion (given hash) has been voted on by given account, leaving a tally (yes votes and no votes given as u32s respectively).")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"councilvoting"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#councilvoting","aria-hidden":"true"}},[e._v("#")]),e._v(" councilVoting")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("TallyCancelation")]),e._v("("),_("code",[e._v("Hash")]),e._v(", "),_("code",[e._v("u32")]),e._v(", "),_("code",[e._v("u32")]),e._v(", "),_("code",[e._v("u32")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A voting tally has happened for a referendum cancellation vote. Last three are yes, no, abstain counts.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("TallyReferendum")]),e._v("("),_("code",[e._v("Hash")]),e._v(", "),_("code",[e._v("u32")]),e._v(", "),_("code",[e._v("u32")]),e._v(", "),_("code",[e._v("u32")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A voting tally has happened for a referendum vote. Last three are yes, no, abstain counts.")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"democracy"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#democracy","aria-hidden":"true"}},[e._v("#")]),e._v(" democracy")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Cancelled")]),e._v("("),_("code",[e._v("ReferendumIndex")]),e._v(")")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Executed")]),e._v("("),_("code",[e._v("ReferendumIndex")]),e._v(", "),_("code",[e._v("bool")]),e._v(")")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("NotPassed")]),e._v("("),_("code",[e._v("ReferendumIndex")]),e._v(")")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Passed")]),e._v("("),_("code",[e._v("ReferendumIndex")]),e._v(")")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Proposed")]),e._v("("),_("code",[e._v("PropIndex")]),e._v(", "),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Started")]),e._v("("),_("code",[e._v("ReferendumIndex")]),e._v(", "),_("code",[e._v("VoteThreshold")]),e._v(")")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Tabled")]),e._v("("),_("code",[e._v("PropIndex")]),e._v(", "),_("code",[e._v("Balance")]),e._v(", "),_("code",[e._v("Vec")]),e._v(")")]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"fees"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#fees","aria-hidden":"true"}},[e._v("#")]),e._v(" fees")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Charged")]),e._v("("),_("code",[e._v("u32")]),e._v(", "),_("code",[e._v("Amount")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Fee charged (extrinsic_index, fee_amount)")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"grandpa"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#grandpa","aria-hidden":"true"}},[e._v("#")]),e._v(" grandpa")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("NewAuthorities")]),e._v("("),_("code",[e._v("Vec<(SessionKey,u64)>")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": New authority set has been applied.")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"indices"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#indices","aria-hidden":"true"}},[e._v("#")]),e._v(" indices")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("NewAccountIndex")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("AccountIndex")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A new account index was assigned. This event is not triggered when an existing index is reassigned to another "),_("code",[e._v("AccountId")]),e._v(".")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"session"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#session","aria-hidden":"true"}},[e._v("#")]),e._v(" session")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("NewSession")]),e._v("("),_("code",[e._v("BlockNumber")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": New session has happened. Note that the argument is the session index, not the block number as the type might suggest.")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"staking"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#staking","aria-hidden":"true"}},[e._v("#")]),e._v(" staking")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("OfflineSlash")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": One validator (and their nominators) has been slashed by the given amount.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("OfflineWarning")]),e._v("("),_("code",[e._v("AccountId")]),e._v(", "),_("code",[e._v("u32")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": One validator (and their nominators) has been given a offline-warning (they're still within their grace). The accrued number of slashes is recorded, too.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Reward")]),e._v("("),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": All validators have been rewarded by the given balance.")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"sudo"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#sudo","aria-hidden":"true"}},[e._v("#")]),e._v(" sudo")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("KeyChanged")]),e._v("("),_("code",[e._v("AccountId")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": The sudoer just switched identity; the old key is supplied.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Sudid")]),e._v("("),_("code",[e._v("bool")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": A sudo just took place.")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"system"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#system","aria-hidden":"true"}},[e._v("#")]),e._v(" system")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ExtrinsicFailed")]),e._v("()")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": An extrinsic failed.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("ExtrinsicSuccess")]),e._v("()")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": An extrinsic completed successfully.")])]),e._v(" "),_("hr"),e._v(" "),_("h3",{attrs:{id:"treasury"}},[_("a",{staticClass:"header-anchor",attrs:{href:"#treasury","aria-hidden":"true"}},[e._v("#")]),e._v(" treasury")]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Awarded")]),e._v("("),_("code",[e._v("ProposalIndex")]),e._v(", "),_("code",[e._v("Balance")]),e._v(", "),_("code",[e._v("AccountId")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Some funds have been allocated.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Burnt")]),e._v("("),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Some of our funds have been burnt.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Proposed")]),e._v("("),_("code",[e._v("ProposalIndex")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": New proposal.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Rollover")]),e._v("("),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": Spending has finished; this is the amount that rolls over until next spend.")])]),e._v(" "),_("p",[e._v("▸ "),_("strong",[e._v("Spending")]),e._v("("),_("code",[e._v("Balance")]),e._v(")")]),e._v(" "),_("ul",[_("li",[_("strong",[e._v("summary")]),e._v(": We have ended a spend period and will now allocate funds.")])])])},[],!1,null,null,null);v.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/60.873c4917.js b/docs/assets/js/60.873c4917.js deleted file mode 100644 index 10b0609c19..0000000000 --- a/docs/assets/js/60.873c4917.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{396:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("DeriveSection")])]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("string")]),e._v("]: "),r("router-link",{attrs:{to:"/api/modules/_types_.html#derivemethod"}},[e._v("DeriveMethod")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/61.18b20d40.js b/docs/assets/js/61.18b20d40.js deleted file mode 100644 index 82a0170ced..0000000000 --- a/docs/assets/js/61.18b20d40.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{397:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("QueryableModuleStorage")])]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("string")]),e._v("]: "),r("router-link",{attrs:{to:"/api/modules/_types_.html#queryablestoragefunction"}},[e._v("QueryableStorageFunction")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/62.5e5f1d72.js b/docs/assets/js/62.5e5f1d72.js deleted file mode 100644 index ab08a8790b..0000000000 --- a/docs/assets/js/62.5e5f1d72.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[62],{399:function(e,t,r){"use strict";r.r(t);var a=r(46),s=Object(a.a)({},function(){var e=this,t=e.$createElement,r=e._self._c||t;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[e._v("#")]),e._v(" Type parameters")]),e._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[e._v("#")]),e._v(" CodecResult")]),e._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[e._v("#")]),e._v(" SubscriptionResult")]),e._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("p",[r("strong",[e._v("QueryableStorage")])]),e._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[e._v("#")]),e._v(" Indexable")]),e._v(" "),r("p",[e._v("[index: "),r("code",[e._v("string")]),e._v("]: "),r("router-link",{attrs:{to:"/api/interfaces/_types_.queryablemodulestorage.html"}},[e._v("QueryableModuleStorage")]),e._v("<"),r("code",[e._v("CodecResult")]),e._v(", "),r("code",[e._v("SubscriptionResult")]),e._v(">")],1)])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/63.2de916c2.js b/docs/assets/js/63.2de916c2.js deleted file mode 100644 index 7ae8ff3cda..0000000000 --- a/docs/assets/js/63.2de916c2.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[63],{400:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),a("h4",{attrs:{id:"codecresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),a("h4",{attrs:{id:"subscriptionresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("code",[t._v("StorageFunction")])]),t._v(" "),a("p",[a("strong",[t._v("↳ QueryableStorageFunctionBase")])]),t._v(" "),a("h1",{attrs:{id:"callable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#callable","aria-hidden":"true"}},[t._v("#")]),t._v(" Callable")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("__call")]),t._v("(arg?: "),a("em",[a("code",[t._v("CodecArg")])]),t._v("): "),a("code",[t._v("CodecResult")])]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("__call")]),t._v("(arg?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:50"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" arg")]),t._v(" "),a("td",[a("code",[t._v("CodecArg")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("CodecResult")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:12"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" arg")]),t._v(" "),a("td",[a("code",[t._v("any")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Uint8Array")])]),t._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),a("p",[a("a",{attrs:{id:"at"}})]),t._v(" "),a("h2",{attrs:{id:"at"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#at","aria-hidden":"true"}},[t._v("#")]),t._v(" at")]),t._v(" "),a("p",[a("strong",[t._v("● at")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L52",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:52"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(hash: "),a("em",[a("code",[t._v("Hash")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])]),t._v(", arg?: "),a("em",[a("code",[t._v("CodecArg")])]),t._v("): "),a("code",[t._v("CodecResult")])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("hash")]),t._v(" "),a("td",[a("code",[t._v("Hash")]),t._v(" | "),a("code",[t._v("Uint8Array")]),t._v(" | "),a("code",[t._v("string")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" arg")]),t._v(" "),a("td",[a("code",[t._v("CodecArg")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("CodecResult")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"hash"}})]),t._v(" "),a("h2",{attrs:{id:"hash"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hash","aria-hidden":"true"}},[t._v("#")]),t._v(" hash")]),t._v(" "),a("p",[a("strong",[t._v("● hash")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L53",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:53"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(arg?: "),a("em",[a("code",[t._v("CodecArg")])]),t._v("): "),a("router-link",{attrs:{to:"/api/modules/_types_.html#hashresult"}},[t._v("HashResult")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" arg")]),t._v(" "),a("td",[a("code",[t._v("CodecArg")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/modules/_types_.html#hashresult"}},[t._v("HashResult")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"key"}})]),t._v(" "),a("h2",{attrs:{id:"key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#key","aria-hidden":"true"}},[t._v("#")]),t._v(" key")]),t._v(" "),a("p",[a("strong",[t._v("● key")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:54"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(arg?: "),a("em",[a("code",[t._v("CodecArg")])]),t._v("): "),a("code",[t._v("string")])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" arg")]),t._v(" "),a("td",[a("code",[t._v("CodecArg")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("string")])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"meta"}})]),t._v(" "),a("h2",{attrs:{id:"meta"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),a("p",[a("strong",[t._v("● meta")]),t._v(": "),a("em",[a("code",[t._v("StorageFunctionMetadata")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from StorageFunction.meta")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:14"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"method"}})]),t._v(" "),a("h2",{attrs:{id:"method"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),a("p",[a("strong",[t._v("● method")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from StorageFunction.method")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:15"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"section"}})]),t._v(" "),a("h2",{attrs:{id:"section"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#section","aria-hidden":"true"}},[t._v("#")]),t._v(" section")]),t._v(" "),a("p",[a("strong",[t._v("● section")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from StorageFunction.section")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:16"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"size"}})]),t._v(" "),a("h2",{attrs:{id:"size"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#size","aria-hidden":"true"}},[t._v("#")]),t._v(" size")]),t._v(" "),a("p",[a("strong",[t._v("● size")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L55",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:55"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(arg?: "),a("em",[a("code",[t._v("CodecArg")])]),t._v("): "),a("router-link",{attrs:{to:"/api/modules/_types_.html#u64result"}},[t._v("U64Result")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" arg")]),t._v(" "),a("td",[a("code",[t._v("CodecArg")])])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/modules/_types_.html#u64result"}},[t._v("U64Result")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tojson"}})]),t._v(" "),a("h2",{attrs:{id:"tojson"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),a("p",[a("strong",[t._v("● toJSON")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from StorageFunction.toJSON")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/StorageKey.ts:17"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(): "),a("code",[t._v("any")])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("any")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/64.afd165df.js b/docs/assets/js/64.afd165df.js deleted file mode 100644 index 16ebf61015..0000000000 --- a/docs/assets/js/64.afd165df.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[64],{402:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("Signer")])]),t._v(" "),r("h1",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("p",[r("a",{attrs:{id:"update"}})]),t._v(" "),r("h2",{attrs:{id:"optional-update"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#optional-update","aria-hidden":"true"}},[t._v("#")]),t._v(" "),r("code",[t._v("")]),t._v(" update")]),t._v(" "),r("p",[r("strong",[t._v("● update")]),t._v(": "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L171",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:171"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Receives an update for the extrinsic signed by a "),r("code",[t._v("signer.sign")])]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"methods"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#methods","aria-hidden":"true"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),r("p",[r("a",{attrs:{id:"sign"}})]),t._v(" "),r("h2",{attrs:{id:"sign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#sign","aria-hidden":"true"}},[t._v("#")]),t._v(" sign")]),t._v(" "),r("p",[t._v("▸ "),r("strong",[t._v("sign")]),t._v("(extrinsic: "),r("em",[r("code",[t._v("Extrinsic")])]),t._v(", address: "),r("em",[r("code",[t._v("string")])]),t._v(", options: "),r("em",[r("code",[t._v("SignatureOptions")])]),t._v("): "),r("code",[t._v("Promise")]),t._v("<"),r("code",[t._v("number")]),t._v(">")]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L166",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:166"),r("OutboundLink")],1)])]),t._v(" "),r("p",[r("em",[r("strong",[t._v("description")])]),t._v(": Signs an extrinsic, returning an id (>0) that can be used to retrieve updates")]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("extrinsic")]),t._v(" "),r("td",[r("code",[t._v("Extrinsic")])])]),t._v(" "),r("tr",[r("td",[t._v("address")]),t._v(" "),r("td",[r("code",[t._v("string")])])]),t._v(" "),r("tr",[r("td",[t._v("options")]),t._v(" "),r("td",[r("code",[t._v("SignatureOptions")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("Promise")]),t._v("<"),r("code",[t._v("number")]),t._v(">")]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/65.ee2bfa33.js b/docs/assets/js/65.ee2bfa33.js deleted file mode 100644 index 24e2599409..0000000000 --- a/docs/assets/js/65.ee2bfa33.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[65],{403:function(t,e,a){"use strict";a.r(e);var r=a(46),s=Object(r.a)({},function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"type-parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),a("h4",{attrs:{id:"codecresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),a("h4",{attrs:{id:"subscriptionresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),a("h1",{attrs:{id:"hierarchy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),a("p",[a("code",[t._v("MethodFunction")])]),t._v(" "),a("p",[a("strong",[t._v("↳ SubmittableExtrinsicFunction")])]),t._v(" "),a("h1",{attrs:{id:"callable"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#callable","aria-hidden":"true"}},[t._v("#")]),t._v(" Callable")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("__call")]),t._v("(...params: "),a("em",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("CodecArg")]),t._v(">")]),t._v("): "),a("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("__call")]),t._v("(...args: "),a("em",[a("code",[t._v("any")]),t._v("[]")]),t._v("): "),a("code",[t._v("Method")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:76"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Rest")]),t._v(" params")]),t._v(" "),a("td",[a("code",[t._v("Array")]),t._v("<"),a("code",[t._v("CodecArg")]),t._v(">")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")]),t._v("<"),a("code",[t._v("CodecResult")]),t._v(", "),a("code",[t._v("SubscriptionResult")]),t._v(">")],1),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:28"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("Rest")]),t._v(" args")]),t._v(" "),a("td",[a("code",[t._v("any")]),t._v("[]")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("Method")])]),t._v(" "),a("h1",{attrs:{id:"properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#properties","aria-hidden":"true"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),a("p",[a("a",{attrs:{id:"callindex"}})]),t._v(" "),a("h2",{attrs:{id:"callindex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#callindex","aria-hidden":"true"}},[t._v("#")]),t._v(" callIndex")]),t._v(" "),a("p",[a("strong",[t._v("● callIndex")]),t._v(": "),a("em",[a("code",[t._v("Uint8Array")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from MethodFunction.callIndex")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:30"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"meta"}})]),t._v(" "),a("h2",{attrs:{id:"meta"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#meta","aria-hidden":"true"}},[t._v("#")]),t._v(" meta")]),t._v(" "),a("p",[a("strong",[t._v("● meta")]),t._v(": "),a("em",[a("code",[t._v("FunctionMetadata")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from MethodFunction.meta")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:31"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"method"}})]),t._v(" "),a("h2",{attrs:{id:"method"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#method","aria-hidden":"true"}},[t._v("#")]),t._v(" method")]),t._v(" "),a("p",[a("strong",[t._v("● method")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from MethodFunction.method")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:32"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"section"}})]),t._v(" "),a("h2",{attrs:{id:"section"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#section","aria-hidden":"true"}},[t._v("#")]),t._v(" section")]),t._v(" "),a("p",[a("strong",[t._v("● section")]),t._v(": "),a("em",[a("code",[t._v("string")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from MethodFunction.section")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:33"),a("OutboundLink")],1)])]),t._v(" "),a("hr"),t._v(" "),a("p",[a("a",{attrs:{id:"tojson"}})]),t._v(" "),a("h2",{attrs:{id:"tojson"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tojson","aria-hidden":"true"}},[t._v("#")]),t._v(" toJSON")]),t._v(" "),a("p",[a("strong",[t._v("● toJSON")]),t._v(": "),a("em",[a("code",[t._v("function")])])]),t._v(" "),a("p",[a("em",[t._v("Inherited from MethodFunction.toJSON")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L34",target:"_blank",rel:"noopener noreferrer"}},[t._v("/home/travis/build/polkadot-js/api/packages/types/src/primitive/Method.ts:34"),a("OutboundLink")],1)])]),t._v(" "),a("h4",{attrs:{id:"type-declaration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),a("p",[t._v("▸(): "),a("code",[t._v("any")])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("any")])]),t._v(" "),a("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/66.9c6a9f66.js b/docs/assets/js/66.9c6a9f66.js deleted file mode 100644 index fb324d449c..0000000000 --- a/docs/assets/js/66.9c6a9f66.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{405:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("SubmittableExtrinsics")])]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[index: "),r("code",[t._v("string")]),t._v("]: "),r("router-link",{attrs:{to:"/api/interfaces/_types_.submittablemoduleextrinsics.html"}},[t._v("SubmittableModuleExtrinsics")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1)])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/67.ff49dc36.js b/docs/assets/js/67.ff49dc36.js deleted file mode 100644 index 6a9160eded..0000000000 --- a/docs/assets/js/67.ff49dc36.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{406:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"type-parameters"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters","aria-hidden":"true"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),r("h4",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),r("h4",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),r("h1",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy","aria-hidden":"true"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("p",[r("strong",[t._v("SubmittableModuleExtrinsics")])]),t._v(" "),r("h1",{attrs:{id:"indexable"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexable","aria-hidden":"true"}},[t._v("#")]),t._v(" Indexable")]),t._v(" "),r("p",[t._v("[index: "),r("code",[t._v("string")]),t._v("]: "),r("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsicfunction.html"}},[t._v("SubmittableExtrinsicFunction")]),t._v("<"),r("code",[t._v("CodecResult")]),t._v(", "),r("code",[t._v("SubscriptionResult")]),t._v(">")],1)])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/68.1de2396b.js b/docs/assets/js/68.1de2396b.js deleted file mode 100644 index d6ce371335..0000000000 --- a/docs/assets/js/68.1de2396b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{408:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/classes/_base_.apibase.html"}},[t._v("ApiBase")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/69.9e892d0b.js b/docs/assets/js/69.9e892d0b.js deleted file mode 100644 index 2a5cb30a85..0000000000 --- a/docs/assets/js/69.9e892d0b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{409:function(t,e,s){"use strict";s.r(e);var a=s(46),r=Object(a.a)({},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("p",[s("a",{attrs:{id:"test"}})]),t._v(" "),s("h2",{attrs:{id:"test"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#test","aria-hidden":"true"}},[t._v("#")]),t._v(" test")]),t._v(" "),s("p",[t._v("▸ "),s("strong",[t._v("test")]),t._v("(): "),s("code",[t._v("Promise")]),t._v("<"),s("code",[t._v("void")]),t._v(">")]),t._v(" "),s("p",[s("em",[t._v("Defined in "),s("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/checkTypes.manual.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("checkTypes.manual.ts:11"),s("OutboundLink")],1)])]),t._v(" "),s("p",[s("strong",[t._v("Returns:")]),t._v(" "),s("code",[t._v("Promise")]),t._v("<"),s("code",[t._v("void")]),t._v(">")]),t._v(" "),s("hr")])},[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/7.7d20a020.js b/docs/assets/js/7.7d20a020.js deleted file mode 100644 index 92d0b9ad7b..0000000000 --- a/docs/assets/js/7.7d20a020.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[7],{721:function(e,t,o){"use strict";o.r(t);var v=o(46),a=Object(v.a)({},function(){var e=this,t=e.$createElement,o=e._self._c||t;return o("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[o("h2",{attrs:{id:"extrinsics"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#extrinsics","aria-hidden":"true"}},[e._v("#")]),e._v(" Extrinsics")]),e._v(" "),o("p",[o("em",[e._v("The following sections contain Extrinsics methods are part of the default Substrate runtime.")])]),e._v(" "),o("ul",[o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#balances"}},[e._v("balances")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#consensus"}},[e._v("consensus")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#contract"}},[e._v("contract")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#council"}},[e._v("council")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#councilMotions"}},[e._v("councilMotions")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#councilVoting"}},[e._v("councilVoting")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#democracy"}},[e._v("democracy")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#grandpa"}},[e._v("grandpa")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#session"}},[e._v("session")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#staking"}},[e._v("staking")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#sudo"}},[e._v("sudo")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#timestamp"}},[e._v("timestamp")])])])]),e._v(" "),o("li",[o("p",[o("strong",[o("a",{attrs:{href:"#treasury"}},[e._v("treasury")])])])])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"balances"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#balances","aria-hidden":"true"}},[e._v("#")]),e._v(" balances")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setBalance")]),e._v("(who: "),o("code",[e._v("Address")]),e._v(", free: "),o("code",[e._v("Compact")]),e._v(", reserved: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the balances of a given account.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("transfer")]),e._v("(dest: "),o("code",[e._v("Address")]),e._v(", value: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Transfer some liquid free balance to another staker.")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"consensus"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#consensus","aria-hidden":"true"}},[e._v("#")]),e._v(" consensus")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("noteOffline")]),e._v("(offline: "),o("code",[e._v("InherentOfflineReport")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Note the previous block's validator missed their opportunity to propose a block.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("remark")]),e._v("(_remark: "),o("code",[e._v("Bytes")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Make some on-chain remark.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("reportMisbehavior")]),e._v("(_report: "),o("code",[e._v("Bytes")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Report some misbehaviour.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setCode")]),e._v("(new: "),o("code",[e._v("Bytes")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the new code.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setHeapPages")]),e._v("(pages: "),o("code",[e._v("u64")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the number of pages in the WebAssembly environment's heap.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setStorage")]),e._v("(items: "),o("code",[e._v("Vec")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set some items of storage.")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"contract"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#contract","aria-hidden":"true"}},[e._v("#")]),e._v(" contract")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("call")]),e._v("(dest: "),o("code",[e._v("Address")]),e._v(", value: "),o("code",[e._v("Compact")]),e._v(", gas_limit: "),o("code",[e._v("Compact")]),e._v(", data: "),o("code",[e._v("Bytes")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Make a call to a specified account, optionally transferring some balance.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("create")]),e._v("(endowment: "),o("code",[e._v("Compact")]),e._v(", gas_limit: "),o("code",[e._v("Compact")]),e._v(", code_hash: "),o("code",[e._v("CodeHash")]),e._v(", data: "),o("code",[e._v("Bytes")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Create a new contract, optionally transfering some balance to the created account. Creation is executed as follows: - the destination address is computed based on the sender and hash of the code. - account is created at the computed address. - the "),o("code",[e._v("ctor_code")]),e._v(" is executed in the context of the newly created account. Buffer returned after the execution is saved as the "),o("code",[e._v("code")]),e._v(" of the account. That code will be invoked upon any message received by this account.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("putCode")]),e._v("(gas_limit: "),o("code",[e._v("Compact")]),e._v(", code: "),o("code",[e._v("Bytes")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Stores code in the storage. You can instantiate contracts only with stored code.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("updateSchedule")]),e._v("(schedule: "),o("code",[e._v("Schedule")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Updates the schedule for metering contracts. The schedule must have a greater version than the stored schedule.")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"council"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#council","aria-hidden":"true"}},[e._v("#")]),e._v(" council")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("presentWinner")]),e._v("(candidate: "),o("code",[e._v("Address")]),e._v(", total: "),o("code",[e._v("Compact")]),e._v(", index: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Claim that "),o("code",[e._v("signed")]),e._v(" is one of the top Self::carry_count() + current_vote().1 candidates. Only works if the "),o("code",[e._v("block_number >= current_vote().0")]),e._v(" and "),o("code",[e._v("< current_vote().0 + presentation_duration()``")]),e._v("signed` should have at least")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("reapInactiveVoter")]),e._v("(reporter_index: "),o("code",[e._v("Compact")]),e._v(", who: "),o("code",[e._v("Address")]),e._v(", who_index: "),o("code",[e._v("Compact")]),e._v(", assumed_vote_index: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Remove a voter. For it not to be a bond-consuming no-op, all approved candidate indices must now be either unregistered or registered to a candidate that registered the slot after the voter gave their last approval set. May be called by anyone. Returns the voter deposit to "),o("code",[e._v("signed")]),e._v(".")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("removeMember")]),e._v("(who: "),o("code",[e._v("Address")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Remove a particular member. A tally will happen instantly (if not already in a presentation period) to fill the seat if removal means that the desired members are not met. This is effective immediately.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("retractVoter")]),e._v("(index: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Remove a voter. All votes are cancelled and the voter deposit is returned.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setApprovals")]),e._v("(votes: "),o("code",[e._v("Vec")]),e._v(", index: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set candidate approvals. Approval slots stay valid as long as candidates in those slots are registered.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setDesiredSeats")]),e._v("(count: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the desired member count; if lower than the current count, then seats will not be up election when they expire. If more, then a new vote will be started if one is not already in progress.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setPresentationDuration")]),e._v("(count: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the presentation duration. If there is currently a vote being presented for, will invoke "),o("code",[e._v("finalise_vote")]),e._v(".")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setTermDuration")]),e._v("(count: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the presentation duration. If there is current a vote being presented for, will invoke "),o("code",[e._v("finalise_vote")]),e._v(".")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("submitCandidacy")]),e._v("(slot: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Submit oneself for candidacy. Account must have enough transferrable funds in it to pay the bond.")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"councilmotions"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#councilmotions","aria-hidden":"true"}},[e._v("#")]),e._v(" councilMotions")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("propose")]),e._v("(threshold: "),o("code",[e._v("Compact")]),e._v(", proposal: "),o("code",[e._v("Proposal")]),e._v(")")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("vote")]),e._v("(proposal: "),o("code",[e._v("Hash")]),e._v(", index: "),o("code",[e._v("Compact")]),e._v(", approve: "),o("code",[e._v("bool")]),e._v(")")]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"councilvoting"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#councilvoting","aria-hidden":"true"}},[e._v("#")]),e._v(" councilVoting")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("propose")]),e._v("(proposal: "),o("code",[e._v("Proposal")]),e._v(")")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setCooloffPeriod")]),e._v("(blocks: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setVotingPeriod")]),e._v("(blocks: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("veto")]),e._v("(proposal_hash: "),o("code",[e._v("Hash")]),e._v(")")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("vote")]),e._v("(proposal: "),o("code",[e._v("Hash")]),e._v(", approve: "),o("code",[e._v("bool")]),e._v(")")]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"democracy"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#democracy","aria-hidden":"true"}},[e._v("#")]),e._v(" democracy")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("cancelQueued")]),e._v("(when: "),o("code",[e._v("Compact")]),e._v(", which: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Cancel a proposal queued for enactment.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("cancelReferendum")]),e._v("(ref_index: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Remove a referendum.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("propose")]),e._v("(proposal: "),o("code",[e._v("Proposal")]),e._v(", value: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Propose a sensitive action to be taken.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("second")]),e._v("(proposal: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Propose a sensitive action to be taken.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("startReferendum")]),e._v("(proposal: "),o("code",[e._v("Proposal")]),e._v(", threshold: "),o("code",[e._v("VoteThreshold")]),e._v(", delay: "),o("code",[e._v("BlockNumber")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Start a referendum.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("vote")]),e._v("(ref_index: "),o("code",[e._v("Compact")]),e._v(", vote: "),o("code",[e._v("Vote")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Vote in a referendum. If "),o("code",[e._v("vote.is_aye()")]),e._v(", the vote is to enact the proposal; otherwise it is a vote to keep the status quo.")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"grandpa"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#grandpa","aria-hidden":"true"}},[e._v("#")]),e._v(" grandpa")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("reportMisbehavior")]),e._v("(_report: "),o("code",[e._v("Bytes")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Report some misbehaviour.")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"session"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#session","aria-hidden":"true"}},[e._v("#")]),e._v(" session")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("forceNewSession")]),e._v("(apply_rewards: "),o("code",[e._v("bool")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Forces a new session.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setKey")]),e._v("(key: "),o("code",[e._v("SessionKey")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Sets the session key of "),o("code",[e._v("_validator")]),e._v(" to "),o("code",[e._v("_key")]),e._v(". This doesn't take effect until the next session.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setLength")]),e._v("(new: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set a new session length. Won't kick in until the next session change (at current length).")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"staking"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#staking","aria-hidden":"true"}},[e._v("#")]),e._v(" staking")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("forceNewEra")]),e._v("(apply_rewards: "),o("code",[e._v("bool")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Force there to be a new era. This also forces a new session immediately after. "),o("code",[e._v("apply_rewards")]),e._v(" should be true for validators to get the session reward.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("nominate")]),e._v("(target: "),o("code",[e._v("Address")]),e._v(")")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("registerPreferences")]),e._v("(intentions_index: "),o("code",[e._v("Compact")]),e._v(", prefs: "),o("code",[e._v("ValidatorPrefs")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the given account's preference for slashing behaviour should they be a validator. An error (no-op) if "),o("code",[e._v("Self::intentions()[intentions_index] != origin")]),e._v(".")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setBondingDuration")]),e._v("(new: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": The length of the bonding duration in eras.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setInvulnerables")]),e._v("(validators: "),o("code",[e._v("Vec")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the validators who cannot be slashed (if any).")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setOfflineSlashGrace")]),e._v("(new: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the offline slash grace period.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setSessionsPerEra")]),e._v("(new: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the number of sessions in an era.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setValidatorCount")]),e._v("(new: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": The ideal number of validators.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("stake")]),e._v("()")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Declare the desire to stake for the transactor. Effects will be felt at the beginning of the next era.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("unnominate")]),e._v("(target_index: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Will panic if called when source isn't currently nominating target. Updates Nominating, NominatorsFor and NominationBalance.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("unstake")]),e._v("(intentions_index: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Retract the desire to stake for the transactor. Effects will be felt at the beginning of the next era.")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"sudo"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#sudo","aria-hidden":"true"}},[e._v("#")]),e._v(" sudo")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setKey")]),e._v("(new: "),o("code",[e._v("Address")]),e._v(")")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("sudo")]),e._v("(proposal: "),o("code",[e._v("Proposal")]),e._v(")")]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"timestamp"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#timestamp","aria-hidden":"true"}},[e._v("#")]),e._v(" timestamp")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("set")]),e._v("(now: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the current time. Extrinsic with this call should be placed at the specific position in the each block (specified by the Trait::TIMESTAMP_SET_POSITION) typically at the start of the each block. This call should be invoked exactly once per block. It will panic at the finalization phase, if this call hasn't been invoked by that time. The timestamp should be greater than the previous one by the amount specified by "),o("code",[e._v("block_period")]),e._v(".")])]),e._v(" "),o("hr"),e._v(" "),o("h3",{attrs:{id:"treasury"}},[o("a",{staticClass:"header-anchor",attrs:{href:"#treasury","aria-hidden":"true"}},[e._v("#")]),e._v(" treasury")]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("approveProposal")]),e._v("(proposal_id: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Approve a proposal. At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("configure")]),e._v("(proposal_bond: "),o("code",[e._v("Compact")]),e._v(", proposal_bond_minimum: "),o("code",[e._v("Compact")]),e._v(", spend_period: "),o("code",[e._v("Compact")]),e._v(", burn: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": (Re-)configure this module.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("proposeSpend")]),e._v("(value: "),o("code",[e._v("Compact")]),e._v(", beneficiary: "),o("code",[e._v("Address")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Put forward a suggestion for spending. A deposit proportional to the value is reserved and slashed if the proposal is rejected. It is returned once the proposal is awarded.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("rejectProposal")]),e._v("(proposal_id: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Reject a proposed spend. The original deposit will be slashed.")])]),e._v(" "),o("p",[e._v("▸ "),o("strong",[e._v("setPot")]),e._v("(new_pot: "),o("code",[e._v("Compact")]),e._v(")")]),e._v(" "),o("ul",[o("li",[o("strong",[e._v("summary")]),e._v(": Set the balance of funds available to spend.")])])])},[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/70.0fa5cf88.js b/docs/assets/js/70.0fa5cf88.js deleted file mode 100644 index 79bab19bd5..0000000000 --- a/docs/assets/js/70.0fa5cf88.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[70],{411:function(t,s,e){"use strict";e.r(s);var a=e(46),r=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/api/classes/_promise_api_.apipromise.html"}},[t._v("ApiPromise")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/71.906dbe9f.js b/docs/assets/js/71.906dbe9f.js deleted file mode 100644 index 33cc2d26c0..0000000000 --- a/docs/assets/js/71.906dbe9f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{412:function(t,a,r){"use strict";r.r(a);var e=r(46),o=Object(e.a)({},function(){var t=this,a=t.$createElement,r=t._self._c||a;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"classes"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api/classes/_promise_combinator_.combinator.html"}},[t._v("Combinator")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorcallback"}},[t._v("CombinatorCallback")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_promise_combinator_.html#combinatorfunction"}},[t._v("CombinatorFunction")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"combinatorcallback"}})]),t._v(" "),r("h2",{attrs:{id:"combinatorcallback"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#combinatorcallback","aria-hidden":"true"}},[t._v("#")]),t._v(" CombinatorCallback")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ CombinatorCallback")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Combinator.ts:9"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(value: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")]),t._v("): "),r("code",[t._v("any")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("value")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("any")]),t._v(">")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("any")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"combinatorfunction"}})]),t._v(" "),r("h2",{attrs:{id:"combinatorfunction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#combinatorfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" CombinatorFunction")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ CombinatorFunction")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/Combinator.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/Combinator.ts:10"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(cb: "),r("em",[r("code",[t._v("function")])]),t._v("): "),r("a",{attrs:{href:""}},[t._v("SubscriptionResult")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("cb")]),t._v(" "),r("td",[r("code",[t._v("function")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("a",{attrs:{href:""}},[t._v("SubscriptionResult")])]),t._v(" "),r("hr")])},[],!1,null,null,null);a.default=o.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/72.77fd6d42.js b/docs/assets/js/72.77fd6d42.js deleted file mode 100644 index b955516237..0000000000 --- a/docs/assets/js/72.77fd6d42.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[72],{415:function(t,e,r){"use strict";r.r(e);var s=r(46),i=Object(s.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api/interfaces/_promise_types_.apipromiseinterface.html"}},[t._v("ApiPromiseInterface")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#queryablestoragefunction"}},[t._v("QueryableStorageFunction")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#submittableextrinsic"}},[t._v("SubmittableExtrinsic")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#submittableextrinsicfunction"}},[t._v("SubmittableExtrinsicFunction")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"codecresult"}})]),t._v(" "),r("h2",{attrs:{id:"codecresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#codecresult","aria-hidden":"true"}},[t._v("#")]),t._v(" CodecResult")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ CodecResult")]),t._v(": "),r("em",[r("code",[t._v("Promise")]),t._v("<"),r("code",[t._v("Codec")]),t._v(">")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/types.ts:13"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"queryablestoragefunction"}})]),t._v(" "),r("h2",{attrs:{id:"queryablestoragefunction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#queryablestoragefunction","aria-hidden":"true"}},[t._v("#")]),t._v(" QueryableStorageFunction")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ QueryableStorageFunction")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestoragefunctionbase.html"}},[t._v("QueryableStorageFunctionBase")]),t._v("<"),r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L19",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/types.ts:19"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"submittableextrinsic"}})]),t._v(" "),r("h2",{attrs:{id:"submittableextrinsic"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#submittableextrinsic","aria-hidden":"true"}},[t._v("#")]),t._v(" SubmittableExtrinsic")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ SubmittableExtrinsic")]),t._v(": "),r("em",[r("code",[t._v("SubmittableExtrinsicBase")]),t._v("<"),r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"submittableextrinsicfunction"}})]),t._v(" "),r("h2",{attrs:{id:"submittableextrinsicfunction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#submittableextrinsicfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" SubmittableExtrinsicFunction")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ SubmittableExtrinsicFunction")]),t._v(": "),r("em",[r("code",[t._v("SubmittableExtrinsicFunctionBase")]),t._v("<"),r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#codecresult"}},[t._v("CodecResult")]),t._v(", "),r("router-link",{attrs:{to:"/api/modules/_promise_types_.html#subscriptionresult"}},[t._v("SubscriptionResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/types.ts:21"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"subscriptionresult"}})]),t._v(" "),r("h2",{attrs:{id:"subscriptionresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#subscriptionresult","aria-hidden":"true"}},[t._v("#")]),t._v(" SubscriptionResult")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ SubscriptionResult")]),t._v(": "),r("em",[r("code",[t._v("Promise")]),t._v("<"),r("code",[t._v("function")]),t._v(">")])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/promise/types.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("promise/types.ts:11"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/73.efcf09f8.js b/docs/assets/js/73.efcf09f8.js deleted file mode 100644 index 44ad7f2a11..0000000000 --- a/docs/assets/js/73.efcf09f8.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[73],{414:function(t,s,a){"use strict";a.r(s);var e=a(46),r=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),a("h3",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/classes/_rx_api_.apirx.html"}},[t._v("ApiRx")])],1)]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/74.22a477fd.js b/docs/assets/js/74.22a477fd.js deleted file mode 100644 index c15f8d225a..0000000000 --- a/docs/assets/js/74.22a477fd.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[74],{417:function(e,t,a){"use strict";a.r(t);var r=a(46),s=Object(r.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[e._v("#")]),e._v(" Index")]),e._v(" "),a("h3",{attrs:{id:"interfaces"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[e._v("#")]),e._v(" Interfaces")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/interfaces/_rx_types_.apirxinterface.html"}},[e._v("ApiRxInterface")])],1)]),e._v(" "),a("h3",{attrs:{id:"type-aliases"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("ul",[a("li",[a("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[e._v("RxResult")])],1)]),e._v(" "),a("hr"),e._v(" "),a("h1",{attrs:{id:"type-aliases-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[e._v("#")]),e._v(" Type aliases")]),e._v(" "),a("p",[a("a",{attrs:{id:"rxresult"}})]),e._v(" "),a("h2",{attrs:{id:"rxresult"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rxresult","aria-hidden":"true"}},[e._v("#")]),e._v(" RxResult")]),e._v(" "),a("p",[a("strong",[e._v("Ƭ RxResult")]),e._v(": "),a("em",[a("code",[e._v("Observable")]),e._v("<"),a("code",[e._v("Codec")]),e._v(">")])]),e._v(" "),a("p",[a("em",[e._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/rx/types.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[e._v("rx/types.ts:10"),a("OutboundLink")],1)])]),e._v(" "),a("hr")])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/75.9e613539.js b/docs/assets/js/75.9e613539.js deleted file mode 100644 index 198bce33b0..0000000000 --- a/docs/assets/js/75.9e613539.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[75],{418:function(t,s,e){"use strict";e.r(s);var a=e(46),i=Object(a.a)({},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),e("h3",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableextrinsic.html"}},[t._v("SubmittableExtrinsic")])],1),t._v(" "),e("li",[e("router-link",{attrs:{to:"/api/classes/_submittableextrinsic_.submittableresult.html"}},[t._v("SubmittableResult")])],1)]),t._v(" "),e("hr")])},[],!1,null,null,null);s.default=i.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/76.fc057215.js b/docs/assets/js/76.fc057215.js deleted file mode 100644 index b9ba449faf..0000000000 --- a/docs/assets/js/76.fc057215.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[76],{420:function(t,e,r){"use strict";r.r(e);var a=r(46),s=Object(a.a)({},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"index"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#index","aria-hidden":"true"}},[t._v("#")]),t._v(" Index")]),t._v(" "),r("h3",{attrs:{id:"interfaces"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interfaces","aria-hidden":"true"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.apibaseinterface.html"}},[t._v("ApiBaseInterface")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.apiinterface_decorated.html"}},[t._v("ApiInterface$Decorated")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.apioptions.html"}},[t._v("ApiOptions")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc.html"}},[t._v("DecoratedRpc")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_method.html"}},[t._v("DecoratedRpc$Method")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.decoratedrpc_section.html"}},[t._v("DecoratedRpc$Section")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.derive.html"}},[t._v("Derive")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.derivemethodbase.html"}},[t._v("DeriveMethodBase")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.derivesection.html"}},[t._v("DeriveSection")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.queryablemodulestorage.html"}},[t._v("QueryableModuleStorage")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestorage.html"}},[t._v("QueryableStorage")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.queryablestoragefunctionbase.html"}},[t._v("QueryableStorageFunctionBase")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.signer.html"}},[t._v("Signer")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsicfunction.html"}},[t._v("SubmittableExtrinsicFunction")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.submittableextrinsics.html"}},[t._v("SubmittableExtrinsics")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/interfaces/_types_.submittablemoduleextrinsics.html"}},[t._v("SubmittableModuleExtrinsics")])],1)]),t._v(" "),r("h3",{attrs:{id:"type-aliases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("ul",[r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_events"}},[t._v("ApiInterface$Events")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apiinterface_rx"}},[t._v("ApiInterface$Rx")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#apitype"}},[t._v("ApiType")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#derivemethod"}},[t._v("DeriveMethod")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#hashresult"}},[t._v("HashResult")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#oncalldefinition"}},[t._v("OnCallDefinition")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#oncallfunction"}},[t._v("OnCallFunction")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#queryablestoragefunction"}},[t._v("QueryableStorageFunction")])],1),t._v(" "),r("li",[r("router-link",{attrs:{to:"/api/modules/_types_.html#u64result"}},[t._v("U64Result")])],1)]),t._v(" "),r("hr"),t._v(" "),r("h1",{attrs:{id:"type-aliases-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type aliases")]),t._v(" "),r("p",[r("a",{attrs:{id:"apiinterface_events"}})]),t._v(" "),r("h2",{attrs:{id:"apiinterface-events"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#apiinterface-events","aria-hidden":"true"}},[t._v("#")]),t._v(" ApiInterface$Events")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ApiInterface$Events")]),t._v(": "),r("em",[r("code",[t._v("RpcRxInterface$Events")]),t._v(' | "ready"')])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L151",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:151"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"apiinterface_rx"}})]),t._v(" "),r("h2",{attrs:{id:"apiinterface-rx"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#apiinterface-rx","aria-hidden":"true"}},[t._v("#")]),t._v(" ApiInterface$Rx")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ApiInterface$Rx")]),t._v(": "),r("em",[r("router-link",{attrs:{to:"/api/interfaces/_types_.apiinterface_decorated.html"}},[t._v("ApiInterface$Decorated")]),t._v("<"),r("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),r("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1)]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L149",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:149"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"apitype"}})]),t._v(" "),r("h2",{attrs:{id:"apitype"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#apitype","aria-hidden":"true"}},[t._v("#")]),t._v(" ApiType")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ ApiType")]),t._v(": "),r("em",[t._v('"promise" | "rxjs"')])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:153"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"derivemethod"}})]),t._v(" "),r("h2",{attrs:{id:"derivemethod"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#derivemethod","aria-hidden":"true"}},[t._v("#")]),t._v(" DeriveMethod")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ DeriveMethod")]),t._v(": "),r("em",[r("code",[t._v("DeriveMethod")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L99",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:99"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"hashresult"}})]),t._v(" "),r("h2",{attrs:{id:"hashresult"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hashresult","aria-hidden":"true"}},[t._v("#")]),t._v(" HashResult")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ HashResult")]),t._v(": "),r("em",[r("code",[t._v("HashResult")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:40"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"oncalldefinition"}})]),t._v(" "),r("h2",{attrs:{id:"oncalldefinition"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#oncalldefinition","aria-hidden":"true"}},[t._v("#")]),t._v(" OnCallDefinition")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ OnCallDefinition")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:18"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(method: "),r("em",[r("router-link",{attrs:{to:"/api/modules/_types_.html#oncallfunction"}},[t._v("OnCallFunction")]),t._v("<"),r("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),r("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1),t._v(", params?: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("CodecArg")]),t._v(">")]),t._v(", callback?: "),r("em",[r("code",[t._v("CodecCallback")])]),t._v(", needsCallback?: "),r("em",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])]),t._v("): "),r("code",[t._v("CodecResult")]),t._v(" | "),r("code",[t._v("SubscriptionResult")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[t._v("method")]),t._v(" "),r("td",[r("router-link",{attrs:{to:"/api/modules/_types_.html#oncallfunction"}},[t._v("OnCallFunction")]),t._v("<"),r("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(", "),r("router-link",{attrs:{to:"/api/modules/_rx_types_.html#rxresult"}},[t._v("RxResult")]),t._v(">")],1)]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" params")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("CodecArg")]),t._v(">")])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" callback")]),t._v(" "),r("td",[r("code",[t._v("CodecCallback")])])]),t._v(" "),r("tr",[r("td",[r("code",[t._v("Optional")]),t._v(" needsCallback")]),t._v(" "),r("td",[r("code",[t._v("undefined")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("code",[t._v("true")])])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("CodecResult")]),t._v(" | "),r("code",[t._v("SubscriptionResult")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"oncallfunction"}})]),t._v(" "),r("h2",{attrs:{id:"oncallfunction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#oncallfunction","aria-hidden":"true"}},[t._v("#")]),t._v(" OnCallFunction")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ OnCallFunction")]),t._v(": "),r("em",[r("code",[t._v("function")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L20",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:20"),r("OutboundLink")],1)])]),t._v(" "),r("h4",{attrs:{id:"type-declaration-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2","aria-hidden":"true"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),r("p",[t._v("▸(...params: "),r("em",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("CodecArg")]),t._v(">")]),t._v("): "),r("code",[t._v("CodecResult")]),t._v(" | "),r("code",[t._v("SubscriptionResult")])]),t._v(" "),r("p",[r("strong",[t._v("Parameters:")])]),t._v(" "),r("table",[r("thead",[r("tr",[r("th",[t._v("Name")]),t._v(" "),r("th",[t._v("Type")])])]),t._v(" "),r("tbody",[r("tr",[r("td",[r("code",[t._v("Rest")]),t._v(" params")]),t._v(" "),r("td",[r("code",[t._v("Array")]),t._v("<"),r("code",[t._v("CodecArg")]),t._v(">")])])])]),t._v(" "),r("p",[r("strong",[t._v("Returns:")]),t._v(" "),r("code",[t._v("CodecResult")]),t._v(" | "),r("code",[t._v("SubscriptionResult")])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"queryablestoragefunction"}})]),t._v(" "),r("h2",{attrs:{id:"queryablestoragefunction"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#queryablestoragefunction","aria-hidden":"true"}},[t._v("#")]),t._v(" QueryableStorageFunction")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ QueryableStorageFunction")]),t._v(": "),r("em",[r("code",[t._v("QueryableStorageFunction")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:63"),r("OutboundLink")],1)])]),t._v(" "),r("hr"),t._v(" "),r("p",[r("a",{attrs:{id:"u64result"}})]),t._v(" "),r("h2",{attrs:{id:"u64result"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#u64result","aria-hidden":"true"}},[t._v("#")]),t._v(" U64Result")]),t._v(" "),r("p",[r("strong",[t._v("Ƭ U64Result")]),t._v(": "),r("em",[r("code",[t._v("U64Result")])])]),t._v(" "),r("p",[r("em",[t._v("Defined in "),r("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/types.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("types.ts:45"),r("OutboundLink")],1)])]),t._v(" "),r("hr")])},[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/77.d2c78482.js b/docs/assets/js/77.d2c78482.js deleted file mode 100644 index a03888eb3b..0000000000 --- a/docs/assets/js/77.d2c78482.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[77],{421:function(e,t,v){"use strict";v.r(t);var r=v(46),_=Object(r.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("h1",{attrs:{id:"functions"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[e._v("#")]),e._v(" Functions")]),e._v(" "),v("p",[v("a",{attrs:{id:"filterevents"}})]),e._v(" "),v("h2",{attrs:{id:"filterevents"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#filterevents","aria-hidden":"true"}},[e._v("#")]),e._v(" filterEvents")]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("filterEvents")]),e._v("(extHash: "),v("em",[v("code",[e._v("Hash")])]),e._v(", __namedParameters: "),v("em",[v("code",[e._v("object")])]),e._v(", allEvents: "),v("em",[v("code",[e._v("Array")]),e._v("<"),v("code",[e._v("EventRecord")]),e._v(">")]),e._v("): "),v("code",[e._v("Array")]),e._v("<"),v("code",[e._v("EventRecord")]),e._v("> | "),v("code",[e._v("undefined")])]),e._v(" "),v("p",[v("em",[e._v("Defined in "),v("a",{attrs:{href:"https://github.com/polkadot-js/api/blob/1ea1f6f/packages/api/src/util/filterEvents.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[e._v("util/filterEvents.ts:9"),v("OutboundLink")],1)])]),e._v(" "),v("p",[v("strong",[e._v("Parameters:")])]),e._v(" "),v("table",[v("thead",[v("tr",[v("th",[e._v("Name")]),e._v(" "),v("th",[e._v("Type")])])]),e._v(" "),v("tbody",[v("tr",[v("td",[e._v("extHash")]),e._v(" "),v("td",[v("code",[e._v("Hash")])])]),e._v(" "),v("tr",[v("td",[e._v("__namedParameters")]),e._v(" "),v("td",[v("code",[e._v("object")])])]),e._v(" "),v("tr",[v("td",[e._v("allEvents")]),e._v(" "),v("td",[v("code",[e._v("Array")]),e._v("<"),v("code",[e._v("EventRecord")]),e._v(">")])])])]),e._v(" "),v("p",[v("strong",[e._v("Returns:")]),e._v(" "),v("code",[e._v("Array")]),e._v("<"),v("code",[e._v("EventRecord")]),e._v("> | "),v("code",[e._v("undefined")])]),e._v(" "),v("hr")])},[],!1,null,null,null);t.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/78.51114efa.js b/docs/assets/js/78.51114efa.js deleted file mode 100644 index 54eddf7cba..0000000000 --- a/docs/assets/js/78.51114efa.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[78],{423:function(t,e,n){"use strict";n.r(e);var s=n(46),l=Object(s.a)({},function(){var t=this.$createElement;return(this._self._c||t)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})},[],!1,null,null,null);e.default=l.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/79.d40e5274.js b/docs/assets/js/79.d40e5274.js deleted file mode 100644 index bf8d134f33..0000000000 --- a/docs/assets/js/79.d40e5274.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[79],{424:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"simple-connect"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#simple-connect","aria-hidden":"true"}},[t._v("#")]),t._v(" Simple Connect")]),t._v(" "),n("p",[t._v("The following example shows how to instantiate a Polkadot API object and use it to connect to a node using ApiPromise.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Required imports")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" WsProvider "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Initialise the provider to connect to the local node")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ws://127.0.0.1:9944'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create the API and wait until ready")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve the chain & node information information via rpc calls")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nodeName"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nodeVersion"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" Promise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("all")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("chain")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("name")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("version")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`You are connected to chain ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" using ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("nodeName"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" v")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("nodeVersion"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/8.91aa366b.js b/docs/assets/js/8.91aa366b.js deleted file mode 100644 index 4cec77d690..0000000000 --- a/docs/assets/js/8.91aa366b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[8],{337:function(e,t,v){"use strict";v.r(t);var _=v(46),s=Object(_.a)({},function(){var e=this,t=e.$createElement,v=e._self._c||t;return v("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[v("h2",{attrs:{id:"json-rpc"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#json-rpc","aria-hidden":"true"}},[e._v("#")]),e._v(" JSON-RPC")]),e._v(" "),v("p",[v("em",[e._v("The following sections contain RPC methods that are Remote Calls available by default and allow you to interact with the actual node, query, and submit. The RPCs are provided by Substrate itself.")])]),e._v(" "),v("ul",[v("li",[v("p",[v("strong",[v("a",{attrs:{href:"#author"}},[e._v("author")])])])]),e._v(" "),v("li",[v("p",[v("strong",[v("a",{attrs:{href:"#chain"}},[e._v("chain")])])])]),e._v(" "),v("li",[v("p",[v("strong",[v("a",{attrs:{href:"#state"}},[e._v("state")])])])]),e._v(" "),v("li",[v("p",[v("strong",[v("a",{attrs:{href:"#system"}},[e._v("system")])])])])]),e._v(" "),v("hr"),e._v(" "),v("h3",{attrs:{id:"author"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#author","aria-hidden":"true"}},[e._v("#")]),e._v(" author")]),e._v(" "),v("p",[v("em",[e._v("Authoring of network items")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("pendingExtrinsics")]),e._v("(): "),v("code",[e._v("PendingExtrinsics")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Returns all pending extrinsics, potentially grouped by sender")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("submitAndWatchExtrinsic")]),e._v("(extrinsic: "),v("code",[e._v("Extrinsic")]),e._v("): "),v("code",[e._v("ExtrinsicStatus")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Subscribe and watch an extrinsic until unsubscribed")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("submitExtrinsic")]),e._v("(extrinsic: "),v("code",[e._v("Extrinsic")]),e._v("): "),v("code",[e._v("Hash")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Submit a fully formatted extrinsic for block inclusion")])]),e._v(" "),v("hr"),e._v(" "),v("h3",{attrs:{id:"chain"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#chain","aria-hidden":"true"}},[e._v("#")]),e._v(" chain")]),e._v(" "),v("p",[v("em",[e._v("Retrieval of chain data")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getBlock")]),e._v("(hash?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("SignedBlock")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Get header and body of a relay chain block")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getBlockHash")]),e._v("(blockNumber?: "),v("code",[e._v("BlockNumber")]),e._v("): "),v("code",[e._v("Hash")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Get the block hash for a specific block")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getFinalisedHead")]),e._v("(): "),v("code",[e._v("Hash")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Get hash of the last finalised block in the canon chain")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getHeader")]),e._v("(hash?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("Header")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the header for a specific block")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getRuntimeVersion")]),e._v("(hash?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("RuntimeVersion")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Get the runtime version (alias of state_getRuntimeVersion)")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subscribeFinalisedHeads")]),e._v("(): "),v("code",[e._v("Header")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the best finalised header via subscription")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subscribeNewHead")]),e._v("(): "),v("code",[e._v("Header")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the best header via subscription")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subscribeRuntimeVersion")]),e._v("(): "),v("code",[e._v("RuntimeVersion")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the runtime version via subscription")])]),e._v(" "),v("hr"),e._v(" "),v("h3",{attrs:{id:"state"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#state","aria-hidden":"true"}},[e._v("#")]),e._v(" state")]),e._v(" "),v("p",[v("em",[e._v("Query of state")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("call")]),e._v("(method: "),v("code",[e._v("Text")]),e._v(", data: "),v("code",[e._v("Bytes")]),e._v(", block?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("Bytes")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Perform a call to a builtin on the chain")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getMetadata")]),e._v("(block?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("Metadata")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Returns the runtime metadata")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getRuntimeVersion")]),e._v("(hash?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("RuntimeVersion")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Get the runtime version")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getStorage")]),e._v("(key: "),v("code",[e._v("StorageKey")]),e._v(", block?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("StorageData")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the storage for a key")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getStorageHash")]),e._v("(key: "),v("code",[e._v("StorageKey")]),e._v(", block?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("Hash")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the storage hash")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("getStorageSize")]),e._v("(key: "),v("code",[e._v("StorageKey")]),e._v(", block?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("u64")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the storage size")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("queryStorage")]),e._v("(keys: "),v("code",[e._v("Vec")]),e._v(", startBlock: "),v("code",[e._v("Hash")]),e._v(", block?: "),v("code",[e._v("Hash")]),e._v("): "),v("code",[e._v("Vec")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Query historical storage entries (by key) starting from a start block")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("subscribeStorage")]),e._v("(keys: "),v("code",[e._v("Vec")]),e._v("): "),v("code",[e._v("StorageChangeSet")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Subscribes to storage changes for the provided keys")])]),e._v(" "),v("hr"),e._v(" "),v("h3",{attrs:{id:"system"}},[v("a",{staticClass:"header-anchor",attrs:{href:"#system","aria-hidden":"true"}},[e._v("#")]),e._v(" system")]),e._v(" "),v("p",[v("em",[e._v("Methods to retrieve system info")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("chain")]),e._v("(): "),v("code",[e._v("Text")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the chain")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("health")]),e._v("(): "),v("code",[e._v("Health")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Return health status of the node")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("name")]),e._v("(): "),v("code",[e._v("Text")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the node name")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("networkState")]),e._v("(): "),v("code",[e._v("NetworkState")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Returns current state of the network")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("peers")]),e._v("(): "),v("code",[e._v("Vec")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Returns the currently connected peers")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("properties")]),e._v("(): "),v("code",[e._v("ChainProperties")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Get a custom set of properties as a JSON object, defined in the chain spec")])]),e._v(" "),v("p",[e._v("▸ "),v("strong",[e._v("version")]),e._v("(): "),v("code",[e._v("Text")])]),e._v(" "),v("ul",[v("li",[v("strong",[e._v("summary")]),e._v(": Retrieves the version of the node")])])])},[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/80.947f0d3e.js b/docs/assets/js/80.947f0d3e.js deleted file mode 100644 index 14d5e2c8c4..0000000000 --- a/docs/assets/js/80.947f0d3e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[80],{426:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"listen-to-new-blocks"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#listen-to-new-blocks","aria-hidden":"true"}},[t._v("#")]),t._v(" Listen to new blocks")]),t._v(" "),n("p",[t._v("This example shows how to subscribe to new blocks.")]),t._v(" "),n("p",[t._v("It displays the block number every time a new block is seen by the node you are connected to.")]),t._v(" "),n("p",[t._v("NOTE: The example runs until you stop it with CTRL+C")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Here we don't pass the (optional) provider, connecting directly to the default")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// node/port, i.e. `ws://127.0.0.1:9944`. Await for the isReady promise to ensure")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the API has connected to the node and completed the initialisation process")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Subscribe to the new headers on-chain. The callback is fired when new headers")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// are found, the call itself returns a promise with a subscription that can be")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// used to unsubscribe from the newHead subscription")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" unsubscribe "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at block: #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/81.e243d073.js b/docs/assets/js/81.e243d073.js deleted file mode 100644 index 3dce3fb199..0000000000 --- a/docs/assets/js/81.e243d073.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[81],{427:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"listen-to-balance-changes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#listen-to-balance-changes","aria-hidden":"true"}},[t._v("#")]),t._v(" Listen to balance changes")]),t._v(" "),a("p",[t._v("This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Known account we want to use (available on dev chain, with funds)")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Alice "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create an await for the API")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve the initial balance. Since the call has no callback, it is simply a promise")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// that resolves to the current on-chain value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" previous "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" has a balance of ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("previous"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`You may leave this example running and start example 06 or transfer any value to ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Here we subscribe to any balance changes and update the on-screen value")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("current"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Calculate the delta")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" change "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" current"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("sub")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("previous"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Only display positive value changes (Since we are pulling `previous` above already,")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the initial balance change will also be zero)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("change"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isZero")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n previous "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" current"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`New balance change of: ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("change"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br"),a("span",{staticClass:"line-number"},[t._v("23")]),a("br"),a("span",{staticClass:"line-number"},[t._v("24")]),a("br"),a("span",{staticClass:"line-number"},[t._v("25")]),a("br"),a("span",{staticClass:"line-number"},[t._v("26")]),a("br"),a("span",{staticClass:"line-number"},[t._v("27")]),a("br"),a("span",{staticClass:"line-number"},[t._v("28")]),a("br"),a("span",{staticClass:"line-number"},[t._v("29")]),a("br"),a("span",{staticClass:"line-number"},[t._v("30")]),a("br"),a("span",{staticClass:"line-number"},[t._v("31")]),a("br"),a("span",{staticClass:"line-number"},[t._v("32")]),a("br"),a("span",{staticClass:"line-number"},[t._v("33")]),a("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/82.95e1e9ef.js b/docs/assets/js/82.95e1e9ef.js deleted file mode 100644 index 5c993aff00..0000000000 --- a/docs/assets/js/82.95e1e9ef.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[82],{429:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"unsubscribe-from-listening-to-updates"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#unsubscribe-from-listening-to-updates","aria-hidden":"true"}},[t._v("#")]),t._v(" Unsubscribe from listening to updates")]),t._v(" "),n("p",[t._v("This example shows how to subscribe to and later unsubscribe from listening to block updates.")]),t._v(" "),n("p",[t._v("In this example we're calling the built-in unsubscribe() function after a timeOut of 20s to cleanup and unsubscribe from listening to updates.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a new instance of the api")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Subscribe to chain updates and log the current block number on update.")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" unsubscribe "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at block: #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// In this example we're calling the unsubscribe() function that is being")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// returned by the api call function after 20s.")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("setTimeout")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("unsubscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Unsubscribed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("20000")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/83.78169173.js b/docs/assets/js/83.78169173.js deleted file mode 100644 index 80b6d8f1e3..0000000000 --- a/docs/assets/js/83.78169173.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[83],{430:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"read-storage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#read-storage","aria-hidden":"true"}},[t._v("#")]),t._v(" Read storage")]),t._v(" "),a("p",[t._v("Many important variables are available through the storage API. This example shows how to call a few of those APIs.")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Our address for Alice on the dev chain")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Alice "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create our API with a default connection to the local node")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Make our basic chain state/storage queries, all in one go")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("accountNonce"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" blockPeriod"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" Promise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("all")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("accountNonce")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blockPeriod")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("session"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("validators")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`accountNonce(")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(") ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("accountNonce"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`blockPeriod ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockPeriod"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" seconds`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("validators "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Retrieve the balances for all validators")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" validatorBalances "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" Promise"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("all")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("authorityId "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("authorityId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Print out the authorityIds and balances of all validators")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'validators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("authorityId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" authorityId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" validatorBalances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br"),a("span",{staticClass:"line-number"},[t._v("23")]),a("br"),a("span",{staticClass:"line-number"},[t._v("24")]),a("br"),a("span",{staticClass:"line-number"},[t._v("25")]),a("br"),a("span",{staticClass:"line-number"},[t._v("26")]),a("br"),a("span",{staticClass:"line-number"},[t._v("27")]),a("br"),a("span",{staticClass:"line-number"},[t._v("28")]),a("br"),a("span",{staticClass:"line-number"},[t._v("29")]),a("br"),a("span",{staticClass:"line-number"},[t._v("30")]),a("br"),a("span",{staticClass:"line-number"},[t._v("31")]),a("br"),a("span",{staticClass:"line-number"},[t._v("32")]),a("br"),a("span",{staticClass:"line-number"},[t._v("33")]),a("br"),a("span",{staticClass:"line-number"},[t._v("34")]),a("br"),a("span",{staticClass:"line-number"},[t._v("35")]),a("br"),a("span",{staticClass:"line-number"},[t._v("36")]),a("br"),a("span",{staticClass:"line-number"},[t._v("37")]),a("br"),a("span",{staticClass:"line-number"},[t._v("38")]),a("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/84.4a6dfa97.js b/docs/assets/js/84.4a6dfa97.js deleted file mode 100644 index f06a7e772c..0000000000 --- a/docs/assets/js/84.4a6dfa97.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[84],{432:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"make-a-simple-transfer"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#make-a-simple-transfer","aria-hidden":"true"}},[t._v("#")]),t._v(" Make a simple transfer")]),t._v(" "),n("p",[t._v("This sample shows how to create a transaction to make a transfer from one an account to another.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API, Keyring and some utility functions")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Keyring "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Important to note that we pad the seed to a length of 32 bytes using ' '")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The underlying seed needs to be exactly 32 bytes in length")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Alice'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("' '")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BOB_ADDR")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create an instance of the keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Keyring")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Add Alice to our keyring (with the known seed for the account)")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" alice "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Instantiate the API")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a extrinsic, transferring 12345 units to Bob")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" transfer "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BOB_ADDR")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("12345")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Sign and send the transaction using our account")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hash "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" transfer"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("alice"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Transfer sent with hash'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" hash"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/85.531e272e.js b/docs/assets/js/85.531e272e.js deleted file mode 100644 index d8a9337079..0000000000 --- a/docs/assets/js/85.531e272e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[85],{433:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"traverse-events"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#traverse-events","aria-hidden":"true"}},[t._v("#")]),t._v(" Traverse events")]),t._v(" "),n("p",[t._v("Query the system events and extract information from them. This example runs until exited via Ctrl-C")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create our API with a default connection to the local node")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to system events via storage")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("events")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\nReceived ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" events:`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// loop through the Vec")]),t._v("\n events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("record"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// extract the phase, event and the event types")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" phase "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" record"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" types "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("typeDef"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// show what we are busy with")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\t")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("section"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(":")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("method"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(":: (phase=")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(")`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\t\\t")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("meta"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("documentation"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// loop through each of the parameters, displaying the type and data")]),t._v("\n event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\t\\t\\t")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("types"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("type"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/86.b95e8133.js b/docs/assets/js/86.b95e8133.js deleted file mode 100644 index f9bd04b0ea..0000000000 --- a/docs/assets/js/86.b95e8133.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[86],{435:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"transfer-events"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transfer-events","aria-hidden":"true"}},[t._v("#")]),t._v(" Transfer events")]),t._v(" "),n("p",[t._v("Display the events that occur during a transfer by sending a value to a random account")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API & Provider and some utility functions")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" testKeyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring/testing'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// utility function for random values")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsU8a "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// some constants we are using in this sample")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("AMOUNT")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("10000")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create an instance of our testign keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If you're using ES6 module imports instead of require, just change this line to:")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// const keyring = testKeyring();")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" testKeyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create the API and wait until ready")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the nonce for the admin key")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" nonce "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("accountNonce")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// find the actual keypair in the keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" alicePair "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPair")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create a new random recipient")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" recipient "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sending'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("AMOUNT")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'from'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" alicePair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'to'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" recipient"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'with nonce'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nonce"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Do the transfer and track the actual status")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("recipient"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("AMOUNT")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("sign")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("alicePair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" nonce "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("send")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" events "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Transaction status:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Finalised'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Completed at block hash'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Events:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" method"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" section "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'\\t'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("section"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("method"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br"),n("span",{staticClass:"line-number"},[t._v("39")]),n("br"),n("span",{staticClass:"line-number"},[t._v("40")]),n("br"),n("span",{staticClass:"line-number"},[t._v("41")]),n("br"),n("span",{staticClass:"line-number"},[t._v("42")]),n("br"),n("span",{staticClass:"line-number"},[t._v("43")]),n("br"),n("span",{staticClass:"line-number"},[t._v("44")]),n("br"),n("span",{staticClass:"line-number"},[t._v("45")]),n("br"),n("span",{staticClass:"line-number"},[t._v("46")]),n("br"),n("span",{staticClass:"line-number"},[t._v("47")]),n("br"),n("span",{staticClass:"line-number"},[t._v("48")]),n("br"),n("span",{staticClass:"line-number"},[t._v("49")]),n("br"),n("span",{staticClass:"line-number"},[t._v("50")]),n("br"),n("span",{staticClass:"line-number"},[t._v("51")]),n("br"),n("span",{staticClass:"line-number"},[t._v("52")]),n("br"),n("span",{staticClass:"line-number"},[t._v("53")]),n("br"),n("span",{staticClass:"line-number"},[t._v("54")]),n("br"),n("span",{staticClass:"line-number"},[t._v("55")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/87.d8fdeb9d.js b/docs/assets/js/87.d8fdeb9d.js deleted file mode 100644 index 5ed9fd5bf3..0000000000 --- a/docs/assets/js/87.d8fdeb9d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[87],{436:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"chain-upgrade"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#chain-upgrade","aria-hidden":"true"}},[t._v("#")]),t._v(" Chain upgrade")]),t._v(" "),n("p",[t._v("Performs a chain upgrade using the "),n("code",[t._v("sudo")]),t._v(" module. This may brick your chain, so us it as an educational sample. (use "),n("code",[t._v("substrate --dev purge-chain")]),t._v(" to remove DB and recover).")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @ts-check")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API & Provider and some utility functions")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" WsProvider "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" testKeyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring/testing'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fs "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fs'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Initialise the provider to connect to the local node")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ws://127.0.0.1:9944'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create the API and wait until ready (optional provider passed through)")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiPromise"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve the upgrade key from the chain state")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" adminId "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("sudo"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("key")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// find the actual keypair in the keyring (if this is an changed value, the key")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// needs to be added to the keyring before - this assumes we have defaults, i.e.")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Alice as the key - and this already exists on the test keyring)")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" testKeyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" adminPair "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPair")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("adminId"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve the runtime to upgrade to")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" code "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("readFileSync")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./test.wasm'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hex'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" proposal "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("consensus"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCode")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`0x")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("code"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Upgrading from ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("adminId"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(", ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("code"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" bytes`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// preform the actual chain upgrade via the sudo module")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("sudo\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("proposal"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("adminPair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" events "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Proposal status:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Finalised'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'You have just upgraded your chain'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Completed at block hash'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Events:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" method"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" section "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'\\t'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("section"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("method"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br"),n("span",{staticClass:"line-number"},[t._v("39")]),n("br"),n("span",{staticClass:"line-number"},[t._v("40")]),n("br"),n("span",{staticClass:"line-number"},[t._v("41")]),n("br"),n("span",{staticClass:"line-number"},[t._v("42")]),n("br"),n("span",{staticClass:"line-number"},[t._v("43")]),n("br"),n("span",{staticClass:"line-number"},[t._v("44")]),n("br"),n("span",{staticClass:"line-number"},[t._v("45")]),n("br"),n("span",{staticClass:"line-number"},[t._v("46")]),n("br"),n("span",{staticClass:"line-number"},[t._v("47")]),n("br"),n("span",{staticClass:"line-number"},[t._v("48")]),n("br"),n("span",{staticClass:"line-number"},[t._v("49")]),n("br"),n("span",{staticClass:"line-number"},[t._v("50")]),n("br"),n("span",{staticClass:"line-number"},[t._v("51")]),n("br"),n("span",{staticClass:"line-number"},[t._v("52")]),n("br"),n("span",{staticClass:"line-number"},[t._v("53")]),n("br"),n("span",{staticClass:"line-number"},[t._v("54")]),n("br"),n("span",{staticClass:"line-number"},[t._v("55")]),n("br"),n("span",{staticClass:"line-number"},[t._v("56")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/88.18d0ae4f.js b/docs/assets/js/88.18d0ae4f.js deleted file mode 100644 index cc50a4d443..0000000000 --- a/docs/assets/js/88.18d0ae4f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[88],{438:function(e,t,a){"use strict";a.r(t);var s=a(46),n=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"apipromise-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#apipromise-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" ApiPromise Examples")]),e._v(" "),a("p",[e._v("Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain. It uses the [[ApiPromise]] interface.")]),e._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites","aria-hidden":"true"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),a("p",[e._v("For the following examples, you need a local node. It is usually convenient testing with:")]),e._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("substrate --dev\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br")])]),a("h2",{attrs:{id:"running-the-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#running-the-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Running the examples")]),e._v(" "),a("p",[e._v("From each folder, run "),a("code",[e._v("yarn")]),e._v(" to install the required dependencies and then run "),a("code",[e._v("yarn start")]),e._v(" to execute the example against the running node.")]),e._v(" "),a("h2",{attrs:{id:"development-accounts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#development-accounts","aria-hidden":"true"}},[e._v("#")]),e._v(" Development accounts")]),e._v(" "),a("p",[e._v("Some of the examples use the following accounts:")]),e._v(" "),a("ul",[a("li",[e._v("Alice: "),a("code",[e._v("5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ")])]),e._v(" "),a("li",[e._v("Bob: "),a("code",[e._v("5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE")])])]),e._v(" "),a("p",[e._v("Those accounts are easy to add if you don't have/see them. The seed of Alice's account is "),a("code",[e._v("Alice␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣")]),e._v(" and the seed of Bob is... well you guess...")]),e._v(" "),a("p",[e._v("NOTE: Note the spaces padding Alice's key up to 32 chars.")])])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/89.0611fea1.js b/docs/assets/js/89.0611fea1.js deleted file mode 100644 index 92d486066a..0000000000 --- a/docs/assets/js/89.0611fea1.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[89],{439:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"simple-connect"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#simple-connect","aria-hidden":"true"}},[t._v("#")]),t._v(" Simple Connect")]),t._v(" "),n("p",[t._v("The following example shows how to instantiate a Polkadot API object and use it to connect to a node using ApiRx.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Required imports")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" zip "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" WsProvider "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/rpc-provider'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Initialise the provider to connect to the local node")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ws://127.0.0.1:9944'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create the API and wait until ready")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We're using RxJs 'zip()' combination operator to get the emitted values")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// of multiple observables as an array")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("zip")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("chain")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("name")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("version")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Then we subscribe to the result")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nodeName"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" nodeVersion"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`You are connected to chain ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" using ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("nodeName"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" v")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("nodeVersion"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/9.a28c3096.js b/docs/assets/js/9.a28c3096.js deleted file mode 100644 index 5e62706be5..0000000000 --- a/docs/assets/js/9.a28c3096.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{503:function(e,v,t){"use strict";t.r(v);var o=t(46),_=Object(o.a)({},function(){var e=this,v=e.$createElement,t=e._self._c||v;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h2",{attrs:{id:"storage"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#storage","aria-hidden":"true"}},[e._v("#")]),e._v(" Storage")]),e._v(" "),t("p",[t("em",[e._v("The following sections contain Storage methods are part of the default Substrate runtime.")])]),e._v(" "),t("ul",[t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#balances"}},[e._v("balances")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#consensus"}},[e._v("consensus")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#contract"}},[e._v("contract")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#council"}},[e._v("council")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#councilMotions"}},[e._v("councilMotions")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#councilVoting"}},[e._v("councilVoting")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#democracy"}},[e._v("democracy")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#fees"}},[e._v("fees")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#grandpaFinality"}},[e._v("grandpaFinality")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#indices"}},[e._v("indices")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#session"}},[e._v("session")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#staking"}},[e._v("staking")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#sudo"}},[e._v("sudo")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#system"}},[e._v("system")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#timestamp"}},[e._v("timestamp")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#treasury"}},[e._v("treasury")])])])]),e._v(" "),t("li",[t("p",[t("strong",[t("a",{attrs:{href:"#substrate"}},[e._v("substrate")])])])])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"balances"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#balances","aria-hidden":"true"}},[e._v("#")]),e._v(" balances")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("creationFee")]),e._v("(): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The fee required to create an account. At least as big as ReclaimRebate.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("existentialDeposit")]),e._v("(): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The minimum amount allowed to keep an account open.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("freeBalance")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The 'free' balance of a given account. This is the only balance that matters in terms of most operations on tokens. It is alone used to determine the balance when in the contract execution environment. When this balance falls below the value of "),t("code",[e._v("ExistentialDeposit")]),e._v(", then the 'current account' is deleted: specifically "),t("code",[e._v("FreeBalance")]),e._v(". Furthermore, "),t("code",[e._v("OnFreeBalanceZero")]),e._v(" callback is invoked, giving a chance to external modules to cleanup data associated with the deleted account. "),t("code",[e._v("system::AccountNonce")]),e._v(" is also deleted if "),t("code",[e._v("ReservedBalance")]),e._v(" is also zero (it also gets collapsed to zero if it ever becomes less than "),t("code",[e._v("ExistentialDeposit")]),e._v(".")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("reservedBalance")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The amount of the balance of a given account that is externally reserved; this can still get slashed, but gets slashed last of all. This balance is a 'reserve' balance that other subsystems use in order to set aside tokens that are still 'owned' by the account holder, but which are suspendable. (This is different and wholly unrelated to the "),t("code",[e._v("Bondage")]),e._v(" system used in the staking module.) When this balance falls below the value of "),t("code",[e._v("ExistentialDeposit")]),e._v(", then this 'reserve account' is deleted: specifically, "),t("code",[e._v("ReservedBalance")]),e._v(". "),t("code",[e._v("system::AccountNonce")]),e._v(" is also deleted if "),t("code",[e._v("FreeBalance")]),e._v(" is also zero (it also gets collapsed to zero if it ever becomes less than "),t("code",[e._v("ExistentialDeposit")]),e._v(".")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("totalIssuance")]),e._v("(): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The total amount of stake on the system.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("transferFee")]),e._v("(): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The fee required to make a transfer.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("vesting")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Information regarding the vesting of a given account.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"consensus"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#consensus","aria-hidden":"true"}},[e._v("#")]),e._v(" consensus")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("originalAuthorities")]),e._v("(): "),t("code",[e._v("Option>")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"contract"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#contract","aria-hidden":"true"}},[e._v("#")]),e._v(" contract")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("blockGasLimit")]),e._v("(): "),t("code",[e._v("Gas")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The maximum amount of gas that could be expended per block.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("callBaseFee")]),e._v("(): "),t("code",[e._v("Gas")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The fee charged for a call into a contract.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("codeHashOf")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The code associated with a given account.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("codeStorage")]),e._v("("),t("code",[e._v("CodeHash")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": A mapping between an original code hash and instrumented wasm code, ready for the execution.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("contractFee")]),e._v("(): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The fee required to create a contract. At least as big as staking's ReclaimRebate.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("createBaseFee")]),e._v("(): "),t("code",[e._v("Gas")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The fee charged for a create of a contract.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentSchedule")]),e._v("(): "),t("code",[e._v("Schedule")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Current cost schedule for contracts.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("gasPrice")]),e._v("(): "),t("code",[e._v("Balance")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The price of one unit of gas.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("gasSpent")]),e._v("(): "),t("code",[e._v("Gas")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Gas spent so far in this block.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("maxDepth")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The maximum nesting level of a call/create stack.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("pristineCode")]),e._v("("),t("code",[e._v("CodeHash")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": A mapping from an original code hash to the original code, untouched by instrumentation.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"council"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#council","aria-hidden":"true"}},[e._v("#")]),e._v(" council")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("activeCouncil")]),e._v("(): "),t("code",[e._v("Vec<(AccountId,BlockNumber)>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The current council. When there's a vote going on, this should still be used for executive matters. The block number (second element in the tuple) is the block that their position is active until (calculated by the sum of the block number when the council member was elected and their term duration).")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("approvalsOf")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": A list of votes for each voter, respecting the last cleared vote index that this voter was last active at.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("candidacyBond")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How much should be locked up in order to submit one's candidacy.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("candidateCount")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("candidates")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The present candidate list.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("carryCount")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How many runners-up should have their approvals persist until the next vote.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("desiredSeats")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Number of accounts that should be sitting on the council.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("inactiveGracePeriod")]),e._v("(): "),t("code",[e._v("VoteIndex")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How many vote indexes need to go by after a target voter's last vote before they can be reaped if their approvals are moot.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("lastActiveOf")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The last cleared vote index that this voter was last active at.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("leaderboard")]),e._v("(): "),t("code",[e._v("Option>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Get the leaderboard if we;re in the presentation phase.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nextFinalise")]),e._v("(): "),t("code",[e._v("Option<(BlockNumber,u32,Vec)>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The accounts holding the seats that will become free on the next tally.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("presentSlashPerVoter")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The punishment, per voter, if you provide an invalid presentation.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("presentationDuration")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How long to give each top candidate to present themselves after the vote ends.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("registerInfoOf")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Option<(VoteIndex,u32)>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The vote index and list slot that the candidate "),t("code",[e._v("who")]),e._v(" was registered or "),t("code",[e._v("None")]),e._v(" if they are not currently registered.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("snapshotedStakes")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The stakes as they were at the point that the vote ended.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("termDuration")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How long each position is active for.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("voteCount")]),e._v("(): "),t("code",[e._v("VoteIndex")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The total number of votes that have happened or are in progress.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("voters")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The present voter list.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("votingBond")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How much should be locked up in order to be able to submit votes.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("votingPeriod")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How often (in blocks) to check for new votes.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"councilmotions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#councilmotions","aria-hidden":"true"}},[e._v("#")]),e._v(" councilMotions")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposalCount")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Proposals so far.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposalOf")]),e._v("("),t("code",[e._v("Hash")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Actual proposal for a given hash, if it's current.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposals")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The (hashes of) the active proposals.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("voting")]),e._v("("),t("code",[e._v("Hash")]),e._v("): "),t("code",[e._v("Option<(ProposalIndex,u32,Vec,Vec)>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Votes for a given proposal: (required_yes_votes, yes_voters, no_voters).")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"councilvoting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#councilvoting","aria-hidden":"true"}},[e._v("#")]),e._v(" councilVoting")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("cooloffPeriod")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("councilVoteOf")]),e._v("("),t("code",[e._v("(Hash,AccountId)")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("enactDelayPeriod")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Number of blocks by which to delay enactment of successful, non-unanimous-council-instigated referendum proposals.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposalOf")]),e._v("("),t("code",[e._v("Hash")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposalVoters")]),e._v("("),t("code",[e._v("Hash")]),e._v("): "),t("code",[e._v("Vec")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposals")]),e._v("(): "),t("code",[e._v("Vec<(BlockNumber,Hash)>")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("vetoedProposal")]),e._v("("),t("code",[e._v("Hash")]),e._v("): "),t("code",[e._v("Option<(BlockNumber,Vec)>")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("votingPeriod")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"democracy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#democracy","aria-hidden":"true"}},[e._v("#")]),e._v(" democracy")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("bondage")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The block at which the "),t("code",[e._v("who")]),e._v("'s funds become liquid.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("depositOf")]),e._v("("),t("code",[e._v("PropIndex")]),e._v("): "),t("code",[e._v("Option<(BalanceOf,Vec)>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Those who have locked a deposit.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("dispatchQueue")]),e._v("("),t("code",[e._v("BlockNumber")]),e._v("): "),t("code",[e._v("Vec>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Queue of successful referenda to be dispatched.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("launchPeriod")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How often (in blocks) new public referenda are launched.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("maxLockPeriods")]),e._v("(): "),t("code",[e._v("LockPeriods")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The maximum number of additional lock periods a voter may offer to strengthen their vote. Multiples of "),t("code",[e._v("PublicDelay")]),e._v(".")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("minimumDeposit")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The minimum amount to be used as a deposit for a public referendum proposal.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nextTally")]),e._v("(): "),t("code",[e._v("ReferendumIndex")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The next referendum index that should be tallied.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("publicDelay")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The delay before enactment for all public referenda.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("publicPropCount")]),e._v("(): "),t("code",[e._v("PropIndex")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The number of (public) proposals that have been made so far.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("publicProps")]),e._v("(): "),t("code",[e._v("Vec<(PropIndex,Proposal,AccountId)>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The public proposals. Unsorted.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("referendumCount")]),e._v("(): "),t("code",[e._v("ReferendumIndex")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The next free referendum index, aka the number of referendums started so far.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("referendumInfoOf")]),e._v("("),t("code",[e._v("ReferendumIndex")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Information concerning any given referendum.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("voteOf")]),e._v("("),t("code",[e._v("(ReferendumIndex,AccountId)")]),e._v("): "),t("code",[e._v("Vote")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Get the vote in a given referendum of a particular voter. The result is meaningful only if "),t("code",[e._v("voters_for")]),e._v(" includes the voter when called with the referendum (you'll get the default "),t("code",[e._v("Vote")]),e._v(" value otherwise). If you don't want to check "),t("code",[e._v("voters_for")]),e._v(", then you can also check for simple existence with "),t("code",[e._v("VoteOf::exists")]),e._v(" first.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("votersFor")]),e._v("("),t("code",[e._v("ReferendumIndex")]),e._v("): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Get the voters for the current proposal.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("votingPeriod")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": How often (in blocks) to check for new votes.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"fees"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#fees","aria-hidden":"true"}},[e._v("#")]),e._v(" fees")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentTransactionFee")]),e._v("("),t("code",[e._v("u32")]),e._v("): "),t("code",[e._v("AssetOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The "),t("code",[e._v("extrinsic_index => accumulated_fees")]),e._v(" map, containing records to track the overall charged fees for each transaction. All records should be removed at finalise stage.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("transactionBaseFee")]),e._v("(): "),t("code",[e._v("AssetOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The fee to be paid for making a transaction; the base.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("transactionByteFee")]),e._v("(): "),t("code",[e._v("AssetOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The fee to be paid for making a transaction; the per-byte portion.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"grandpafinality"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#grandpafinality","aria-hidden":"true"}},[e._v("#")]),e._v(" grandpaFinality")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("pendingChange")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"indices"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#indices","aria-hidden":"true"}},[e._v("#")]),e._v(" indices")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("enumSet")]),e._v("("),t("code",[e._v("AccountIndex")]),e._v("): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The enumeration sets.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nextEnumSet")]),e._v("(): "),t("code",[e._v("AccountIndex")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The next free enumeration set.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"session"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#session","aria-hidden":"true"}},[e._v("#")]),e._v(" session")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentIndex")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Current index of the session.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentStart")]),e._v("(): "),t("code",[e._v("Moment")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Timestamp when current session started.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("forcingNewSession")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": New session is being forced is this entry exists; in which case, the boolean value is whether the new session should be considered a normal rotation (rewardable) or exceptional (slashable).")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("lastLengthChange")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Block at which the session length last changed.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nextKeyFor")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The next key for a given validator.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nextSessionLength")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The next session length.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("sessionLength")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Current length of the session.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("validators")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The current set of validators.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"staking"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#staking","aria-hidden":"true"}},[e._v("#")]),e._v(" staking")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("bondage")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The block at which the "),t("code",[e._v("who")]),e._v("'s funds become entirely liquid.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("bondingDuration")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The length of the bonding duration in blocks.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentEra")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The current era index.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentNominatorsFor")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Nominators for a particular account that is in action right now.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentOfflineSlash")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Slash, per validator that is taken for the first time they are found to be offline.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("currentSessionReward")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Maximum reward, per validator, that is provided per acceptable session.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("forcingNewEra")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": We are forcing a new era.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("intentions")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": All the accounts with a desire to stake.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("invulerables")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Any validators that may never be slashed or forcible kicked. It's a Vec since they're easy to initialise and the performance hit is minimal (we expect no more than four invulnerables) and restricted to testnets.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("lastEraLengthChange")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The session index at which the era length last changed.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("minimumValidatorCount")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Minimum number of staking participants before emergency conditions are imposed.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nextSessionsPerEra")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The next value of sessions per era.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nominating")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": All nominator -> nominee relationships.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("nominatorsFor")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Nominators for a particular account.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("offlineSlash")]),e._v("(): "),t("code",[e._v("Perbill")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Slash, per validator that is taken for the first time they are found to be offline.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("offlineSlashGrace")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Number of instances of offline reports before slashing begins for validators.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("recentlyOffline")]),e._v("(): "),t("code",[e._v("Vec<(AccountId,BlockNumber,u32)>")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Most recent "),t("code",[e._v("RECENT_OFFLINE_COUNT")]),e._v(" instances. (who it was, when it was reported, how many instances they were offline for).")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("sessionReward")]),e._v("(): "),t("code",[e._v("Perbill")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Maximum reward, per validator, that is provided per acceptable session.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("sessionsPerEra")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The length of a staking era in sessions.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("slashCount")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The number of times a given validator has been reported offline. This gets decremented by one each era that passes.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("stakeRange")]),e._v("(): "),t("code",[e._v("(BalanceOf,BalanceOf)")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The highest and lowest staked validator slashable balances.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("validatorCount")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The ideal number of staking participants.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("validatorPreferences")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("ValidatorPrefs")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Preferences that a validator has.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"sudo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sudo","aria-hidden":"true"}},[e._v("#")]),e._v(" sudo")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("key")]),e._v("(): "),t("code",[e._v("AccountId")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"system"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#system","aria-hidden":"true"}},[e._v("#")]),e._v(" system")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("accountNonce")]),e._v("("),t("code",[e._v("AccountId")]),e._v("): "),t("code",[e._v("Index")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("allExtrinsicsLen")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("blockHash")]),e._v("("),t("code",[e._v("BlockNumber")]),e._v("): "),t("code",[e._v("Hash")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("digest")]),e._v("(): "),t("code",[e._v("Digest")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("events")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("extrinsicCount")]),e._v("(): "),t("code",[e._v("Option")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("extrinsicData")]),e._v("("),t("code",[e._v("u32")]),e._v("): "),t("code",[e._v("Bytes")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("extrinsicsRoot")]),e._v("(): "),t("code",[e._v("Hash")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("number")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The current block number being processed. Set by "),t("code",[e._v("execute_block")]),e._v(".")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("parentHash")]),e._v("(): "),t("code",[e._v("Hash")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("randomSeed")]),e._v("(): "),t("code",[e._v("Hash")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"timestamp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#timestamp","aria-hidden":"true"}},[e._v("#")]),e._v(" timestamp")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("blockPeriod")]),e._v("(): "),t("code",[e._v("Moment")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": The minimum (and advised) period between blocks.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("didUpdate")]),e._v("(): "),t("code",[e._v("bool")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Did the timestamp get updated in this block?")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("now")]),e._v("(): "),t("code",[e._v("Moment")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Current time for the current block.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"treasury"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#treasury","aria-hidden":"true"}},[e._v("#")]),e._v(" treasury")]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("approvals")]),e._v("(): "),t("code",[e._v("Vec")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Proposal indices that have been approved but not yet awarded.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("burn")]),e._v("(): "),t("code",[e._v("Permill")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Percentage of spare funds (if any) that are burnt per spend period.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("pot")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Total funds available to this module for spending.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposalBond")]),e._v("(): "),t("code",[e._v("Permill")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Proportion of funds that should be bonded in order to place a proposal. An accepted proposal gets these back. A rejected proposal doesn't.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposalBondMinimum")]),e._v("(): "),t("code",[e._v("BalanceOf")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Minimum amount of funds that should be placed in a deposit for making a proposal.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposalCount")]),e._v("(): "),t("code",[e._v("ProposalIndex")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Number of proposals that have been made.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("proposals")]),e._v("("),t("code",[e._v("ProposalIndex")]),e._v("): "),t("code",[e._v("Option")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Proposals that have been made.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("spendPeriod")]),e._v("(): "),t("code",[e._v("BlockNumber")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Period between successive spends.")])]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"substrate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#substrate","aria-hidden":"true"}},[e._v("#")]),e._v(" substrate")]),e._v(" "),t("p",[t("em",[e._v("These are keys that are always available to the runtime implementation")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("authorityCount")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Number of authorities.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("authorityPrefix")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Prefix under which authorities are storied.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("changesTrieConfig")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Changes trie configuration is stored under this key.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("code")]),e._v("(): "),t("code",[e._v("Bytes")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Wasm code of the runtime.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("extrinsicIndex")]),e._v("(): "),t("code",[e._v("u32")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Current extrinsic index (u32) is stored under this key.")])]),e._v(" "),t("p",[e._v("▸ "),t("strong",[e._v("heapPages")]),e._v("(): "),t("code",[e._v("u64")])]),e._v(" "),t("ul",[t("li",[t("strong",[e._v("summary")]),e._v(": Number of wasm linear memory pages required for execution of the runtime.")])]),e._v(" "),t("hr")])},[],!1,null,null,null);v.default=_.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/90.0eda8f57.js b/docs/assets/js/90.0eda8f57.js deleted file mode 100644 index e806ccb261..0000000000 --- a/docs/assets/js/90.0eda8f57.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[90],{441:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"listen-to-new-blocks"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#listen-to-new-blocks","aria-hidden":"true"}},[t._v("#")]),t._v(" Listen to new blocks")]),t._v(" "),n("p",[t._v("This example shows how to subscribe to new blocks.")]),t._v(" "),n("p",[t._v("It displays the block number every time a new block is seen by the node you are connected to.")]),t._v(" "),n("p",[t._v("NOTE: The example runs until you stop it with CTRL+C")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" switchMap "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Here we don't pass the (optional) provider, connecting directly to the default")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// node/port, i.e. `ws://127.0.0.1:9944`. Await for the isReady promise to ensure")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the API has connected to the node and completed the initialisation process")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ApiRx")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at block: #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/91.8bbc3dd9.js b/docs/assets/js/91.8bbc3dd9.js deleted file mode 100644 index 881c9bcbc5..0000000000 --- a/docs/assets/js/91.8bbc3dd9.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[91],{442:function(e,t,a){"use strict";a.r(t);var s=a(46),n=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"listen-to-balance-changes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#listen-to-balance-changes","aria-hidden":"true"}},[e._v("#")]),e._v(" Listen to balance changes")]),e._v(" "),a("p",[e._v("This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.")]),e._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("Not found: /home/travis/build/polkadot-js/api/docs/examples/rx/03_listent_to_balance_change/index.js")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"})])])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/92.f2a6b3f4.js b/docs/assets/js/92.f2a6b3f4.js deleted file mode 100644 index c47318c589..0000000000 --- a/docs/assets/js/92.f2a6b3f4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[92],{444:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"unsubscribe-from-listening-to-updates"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#unsubscribe-from-listening-to-updates","aria-hidden":"true"}},[t._v("#")]),t._v(" Unsubscribe from listening to updates")]),t._v(" "),n("p",[t._v("This example shows how to subscribe to and later unsubscribe from listening to block updates.")]),t._v(" "),n("p",[t._v("In this example we're calling the built-in unsubscribe() function after a timeOut of 20s to cleanup and unsubscribe from listening to updates.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" switchMap "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a new instance of the api")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Subscribe to chain updates and log the current block number on update.")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" subscription "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ApiRx")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rpc"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Chain is at block: #")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// In this example we're calling the Overvables unsubscribe() //")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// function after 20s.")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("setTimeout")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n subscription"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("unsubscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Unsubscribed'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("20000")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/93.d506ddb5.js b/docs/assets/js/93.d506ddb5.js deleted file mode 100644 index fd32e87382..0000000000 --- a/docs/assets/js/93.d506ddb5.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[93],{445:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"read-storage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#read-storage","aria-hidden":"true"}},[t._v("#")]),t._v(" Read storage")]),t._v(" "),a("p",[t._v("Many important variables are available through the storage API. This example shows how to call a few of those APIs.")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import dependencies from RxJs")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" combineLatest"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" first"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" switchMap "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Our address for Alice on the dev chain")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" Alice "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create our API with a default connection to the local node")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ApiRx")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("isReady\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Here we ake our basic chain state/storage queries")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("combineLatest")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("session"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("validators")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("first")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// In the next step, we're checking if the node has active validators.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If it does, we're making another call to the api to get the balances for all validators")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" balances "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("validators "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("combineLatest")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("authorityId "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("freeBalance")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("authorityId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("first")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// We're combining the results together with the emitted value 'validators',")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// which we're turning back into an observable using of()")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("combineLatest")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("accountNonce")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("first")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("timestamp"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("blockPeriod")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("first")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("of")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n balances\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Then we're subscribing to the emitted results")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("accountNonce"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" blockPeriod"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" validatorBalances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`accountNonce(")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("Alice"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(") ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("accountNonce"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`blockPeriod ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("blockPeriod"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toNumber")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v(" seconds`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("validatorBalances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// And lastly we print out the authorityIds and balances of all validators")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'validators'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" validators"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("authorityId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n address"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" authorityId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n balance"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" validatorBalances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br"),a("span",{staticClass:"line-number"},[t._v("16")]),a("br"),a("span",{staticClass:"line-number"},[t._v("17")]),a("br"),a("span",{staticClass:"line-number"},[t._v("18")]),a("br"),a("span",{staticClass:"line-number"},[t._v("19")]),a("br"),a("span",{staticClass:"line-number"},[t._v("20")]),a("br"),a("span",{staticClass:"line-number"},[t._v("21")]),a("br"),a("span",{staticClass:"line-number"},[t._v("22")]),a("br"),a("span",{staticClass:"line-number"},[t._v("23")]),a("br"),a("span",{staticClass:"line-number"},[t._v("24")]),a("br"),a("span",{staticClass:"line-number"},[t._v("25")]),a("br"),a("span",{staticClass:"line-number"},[t._v("26")]),a("br"),a("span",{staticClass:"line-number"},[t._v("27")]),a("br"),a("span",{staticClass:"line-number"},[t._v("28")]),a("br"),a("span",{staticClass:"line-number"},[t._v("29")]),a("br"),a("span",{staticClass:"line-number"},[t._v("30")]),a("br"),a("span",{staticClass:"line-number"},[t._v("31")]),a("br"),a("span",{staticClass:"line-number"},[t._v("32")]),a("br"),a("span",{staticClass:"line-number"},[t._v("33")]),a("br"),a("span",{staticClass:"line-number"},[t._v("34")]),a("br"),a("span",{staticClass:"line-number"},[t._v("35")]),a("br"),a("span",{staticClass:"line-number"},[t._v("36")]),a("br"),a("span",{staticClass:"line-number"},[t._v("37")]),a("br"),a("span",{staticClass:"line-number"},[t._v("38")]),a("br"),a("span",{staticClass:"line-number"},[t._v("39")]),a("br"),a("span",{staticClass:"line-number"},[t._v("40")]),a("br"),a("span",{staticClass:"line-number"},[t._v("41")]),a("br"),a("span",{staticClass:"line-number"},[t._v("42")]),a("br"),a("span",{staticClass:"line-number"},[t._v("43")]),a("br"),a("span",{staticClass:"line-number"},[t._v("44")]),a("br"),a("span",{staticClass:"line-number"},[t._v("45")]),a("br"),a("span",{staticClass:"line-number"},[t._v("46")]),a("br"),a("span",{staticClass:"line-number"},[t._v("47")]),a("br"),a("span",{staticClass:"line-number"},[t._v("48")]),a("br"),a("span",{staticClass:"line-number"},[t._v("49")]),a("br"),a("span",{staticClass:"line-number"},[t._v("50")]),a("br"),a("span",{staticClass:"line-number"},[t._v("51")]),a("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/94.22bb7e14.js b/docs/assets/js/94.22bb7e14.js deleted file mode 100644 index 9da518fcf2..0000000000 --- a/docs/assets/js/94.22bb7e14.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[94],{447:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"make-a-simple-transfer"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#make-a-simple-transfer","aria-hidden":"true"}},[t._v("#")]),t._v(" Make a simple transfer")]),t._v(" "),n("p",[t._v("This sample shows how to create a transaction to make a transfer from one an account to another.")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API, Keyring and some utility functions")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiPromise "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Keyring "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" stringToU8a "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Alice'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("padEnd")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("' '")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BOB_ADDR")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create an instance of the keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Keyring")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Add Alice to our keyring (with the known seed for the account)")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" alice "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringToU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE_SEED")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Instantiate the API")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a extrinsic, transferring 12345 units to Bob.")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create transfer")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("BOB")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" randomAmount"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Sign and send the transcation")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("alice"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Subscribe to the status updates of the transfer")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Finalised'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Successful transfer of 12345 from Alice to Bob with hash ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Staus of transfer: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("type"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("finally")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_ "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/95.6985ab8e.js b/docs/assets/js/95.6985ab8e.js deleted file mode 100644 index aebc4f1963..0000000000 --- a/docs/assets/js/95.6985ab8e.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[95],{448:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"traverse-events"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#traverse-events","aria-hidden":"true"}},[t._v("#")]),t._v(" Traverse events")]),t._v(" "),n("p",[t._v("Query the system events and extract information from them. This example runs until exited via Ctrl-C")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API and selected RxJs operators")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" switchMap "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rxjs/operators'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create our API with a default connection to the local node")]),t._v("\n ApiRx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("pipe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("switchMap")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to system events via storage")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("system"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("events")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Then we're subscribing to the emitted results")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\nReceived ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(" events:`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// loop through the Vec")]),t._v("\n events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("record"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// extract the phase, event and the event types")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" phase "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" record"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" types "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("typeDef"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// show what we are busy with")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\t")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("section"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(":")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("method"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(":: (phase=")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(")`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\t\\t")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("meta"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("documentation"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// loop through each of the parameters, displaying the type and data")]),t._v("\n event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`\\t\\t\\t")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("types"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("type"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(": ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/96.2378ec2d.js b/docs/assets/js/96.2378ec2d.js deleted file mode 100644 index 7b0e25252d..0000000000 --- a/docs/assets/js/96.2378ec2d.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[96],{450:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"transfer-events"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#transfer-events","aria-hidden":"true"}},[t._v("#")]),t._v(" Transfer events")]),t._v(" "),n("p",[t._v("Display the events that occur during a transfer by sending a value to a random account")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API and some utility functions")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" testKeyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring/testing'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// utility function for random values")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" randomAsU8a "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util-crypto'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// some constants we are using in this sample")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("AMOUNT")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("10000")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create an instance of our testign keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If you're using ES6 module imports instead of require, just change this line to:")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// const keyring = testKeyring();")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" testKeyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create our API with a connection to the node")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// find the actual keypair in the keyring")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" alicePair "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPair")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("ALICE")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// create a new random recipient")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" recipient "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("addFromSeed")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("randomAsU8a")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("32")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sending'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("AMOUNT")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'from'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" alicePair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("address")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'to'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" recipient"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// get the nonce for the admin key")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a extrinsic, transferring 12345 units to Bob.")]),t._v("\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("balances\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Do the transfer")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("transfer")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("recipient"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token constant"}},[t._v("AMOUNT")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Sign and send it")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("alicePair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// And subscribe to the actual status")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" events "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Log transfer events")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Transfer status:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Log system events once the transfer is finalised")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Finalised'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Completed at block hash'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Events:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" method"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" section "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'\\t'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("section"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("method"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br"),n("span",{staticClass:"line-number"},[t._v("39")]),n("br"),n("span",{staticClass:"line-number"},[t._v("40")]),n("br"),n("span",{staticClass:"line-number"},[t._v("41")]),n("br"),n("span",{staticClass:"line-number"},[t._v("42")]),n("br"),n("span",{staticClass:"line-number"},[t._v("43")]),n("br"),n("span",{staticClass:"line-number"},[t._v("44")]),n("br"),n("span",{staticClass:"line-number"},[t._v("45")]),n("br"),n("span",{staticClass:"line-number"},[t._v("46")]),n("br"),n("span",{staticClass:"line-number"},[t._v("47")]),n("br"),n("span",{staticClass:"line-number"},[t._v("48")]),n("br"),n("span",{staticClass:"line-number"},[t._v("49")]),n("br"),n("span",{staticClass:"line-number"},[t._v("50")]),n("br"),n("span",{staticClass:"line-number"},[t._v("51")]),n("br"),n("span",{staticClass:"line-number"},[t._v("52")]),n("br"),n("span",{staticClass:"line-number"},[t._v("53")]),n("br"),n("span",{staticClass:"line-number"},[t._v("54")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/97.1402a4d4.js b/docs/assets/js/97.1402a4d4.js deleted file mode 100644 index 88db7bcae2..0000000000 --- a/docs/assets/js/97.1402a4d4.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{451:function(t,s,n){"use strict";n.r(s);var a=n(46),e=Object(a.a)({},function(){var t=this,s=t.$createElement,n=t._self._c||s;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"chain-upgrade"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#chain-upgrade","aria-hidden":"true"}},[t._v("#")]),t._v(" Chain upgrade")]),t._v(" "),n("p",[t._v("Performs a chain upgrade using the "),n("code",[t._v("sudo")]),t._v(" module. This may brick your chain, so us it as an educational sample. (use "),n("code",[t._v("substrate --dev purge-chain")]),t._v(" to remove DB and recover).")]),t._v(" "),n("div",{staticClass:"language-js line-numbers-mode"},[n("pre",{pre:!0,attrs:{class:"language-js"}},[n("code",[n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Import the API & Provider and some utility functions")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ApiRx "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/api'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" WsProvider "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/rpc-provider'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" testKeyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/keyring/testing'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" fs "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'fs'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("async")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Initialise the provider to connect to the local node")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ws://127.0.0.1:9944'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create the API and wait until ready (optional provider passed through)")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" ApiRx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("create")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve the upgrade key from the chain state")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" adminId "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("query"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("sudo"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("key")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toPromise")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// find the actual keypair in the keyring (if this is an changed value, the key")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// needs to be added to the keyring before - this assumes we have defaults, i.e.")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Alice as the key - and this already exists on the test keyring)")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" keyring "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" testKeyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" adminPair "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" keyring"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPair")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("adminId"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// retrieve the runtime to upgrade to")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" code "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" fs"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("readFileSync")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'./test.wasm'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hex'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" proposal "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("consensus"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("setCode")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`0x")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("code"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`Upgrading chain runtime from ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("adminId"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n api"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tx"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("sudo\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// preform the actual chain upgrade via the sudo module")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("proposal"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// sign and send the proposal")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("signAndSend")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("adminPair"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// subscribe to overall result")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribe")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" events "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Log transfer events")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Proposal status:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" type"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Finalised'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'You have just upgraded your chain'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Completed at block hash'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" status"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("asFinalised"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toHex")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Events:'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),n("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Log system events once the chain update is finalised")]),t._v("\n events"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" event"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" method"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" section "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("'\\t'")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" phase"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token template-string"}},[n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`: ")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("section"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token interpolation"}},[n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("method"),n("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),n("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" data"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("main")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n process"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),n("span",{pre:!0,attrs:{class:"token function"}},[t._v("exit")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),n("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),n("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),n("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),n("div",{staticClass:"line-numbers-wrapper"},[n("span",{staticClass:"line-number"},[t._v("1")]),n("br"),n("span",{staticClass:"line-number"},[t._v("2")]),n("br"),n("span",{staticClass:"line-number"},[t._v("3")]),n("br"),n("span",{staticClass:"line-number"},[t._v("4")]),n("br"),n("span",{staticClass:"line-number"},[t._v("5")]),n("br"),n("span",{staticClass:"line-number"},[t._v("6")]),n("br"),n("span",{staticClass:"line-number"},[t._v("7")]),n("br"),n("span",{staticClass:"line-number"},[t._v("8")]),n("br"),n("span",{staticClass:"line-number"},[t._v("9")]),n("br"),n("span",{staticClass:"line-number"},[t._v("10")]),n("br"),n("span",{staticClass:"line-number"},[t._v("11")]),n("br"),n("span",{staticClass:"line-number"},[t._v("12")]),n("br"),n("span",{staticClass:"line-number"},[t._v("13")]),n("br"),n("span",{staticClass:"line-number"},[t._v("14")]),n("br"),n("span",{staticClass:"line-number"},[t._v("15")]),n("br"),n("span",{staticClass:"line-number"},[t._v("16")]),n("br"),n("span",{staticClass:"line-number"},[t._v("17")]),n("br"),n("span",{staticClass:"line-number"},[t._v("18")]),n("br"),n("span",{staticClass:"line-number"},[t._v("19")]),n("br"),n("span",{staticClass:"line-number"},[t._v("20")]),n("br"),n("span",{staticClass:"line-number"},[t._v("21")]),n("br"),n("span",{staticClass:"line-number"},[t._v("22")]),n("br"),n("span",{staticClass:"line-number"},[t._v("23")]),n("br"),n("span",{staticClass:"line-number"},[t._v("24")]),n("br"),n("span",{staticClass:"line-number"},[t._v("25")]),n("br"),n("span",{staticClass:"line-number"},[t._v("26")]),n("br"),n("span",{staticClass:"line-number"},[t._v("27")]),n("br"),n("span",{staticClass:"line-number"},[t._v("28")]),n("br"),n("span",{staticClass:"line-number"},[t._v("29")]),n("br"),n("span",{staticClass:"line-number"},[t._v("30")]),n("br"),n("span",{staticClass:"line-number"},[t._v("31")]),n("br"),n("span",{staticClass:"line-number"},[t._v("32")]),n("br"),n("span",{staticClass:"line-number"},[t._v("33")]),n("br"),n("span",{staticClass:"line-number"},[t._v("34")]),n("br"),n("span",{staticClass:"line-number"},[t._v("35")]),n("br"),n("span",{staticClass:"line-number"},[t._v("36")]),n("br"),n("span",{staticClass:"line-number"},[t._v("37")]),n("br"),n("span",{staticClass:"line-number"},[t._v("38")]),n("br"),n("span",{staticClass:"line-number"},[t._v("39")]),n("br"),n("span",{staticClass:"line-number"},[t._v("40")]),n("br"),n("span",{staticClass:"line-number"},[t._v("41")]),n("br"),n("span",{staticClass:"line-number"},[t._v("42")]),n("br"),n("span",{staticClass:"line-number"},[t._v("43")]),n("br"),n("span",{staticClass:"line-number"},[t._v("44")]),n("br"),n("span",{staticClass:"line-number"},[t._v("45")]),n("br"),n("span",{staticClass:"line-number"},[t._v("46")]),n("br"),n("span",{staticClass:"line-number"},[t._v("47")]),n("br"),n("span",{staticClass:"line-number"},[t._v("48")]),n("br"),n("span",{staticClass:"line-number"},[t._v("49")]),n("br"),n("span",{staticClass:"line-number"},[t._v("50")]),n("br"),n("span",{staticClass:"line-number"},[t._v("51")]),n("br"),n("span",{staticClass:"line-number"},[t._v("52")]),n("br"),n("span",{staticClass:"line-number"},[t._v("53")]),n("br"),n("span",{staticClass:"line-number"},[t._v("54")]),n("br"),n("span",{staticClass:"line-number"},[t._v("55")]),n("br"),n("span",{staticClass:"line-number"},[t._v("56")]),n("br"),n("span",{staticClass:"line-number"},[t._v("57")]),n("br"),n("span",{staticClass:"line-number"},[t._v("58")]),n("br"),n("span",{staticClass:"line-number"},[t._v("59")]),n("br")])])])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/98.e668802c.js b/docs/assets/js/98.e668802c.js deleted file mode 100644 index e4ac41c74c..0000000000 --- a/docs/assets/js/98.e668802c.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[98],{453:function(e,t,a){"use strict";a.r(t);var s=a(46),n=Object(s.a)({},function(){var e=this,t=e.$createElement,a=e._self._c||t;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"apirx-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#apirx-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" ApiRx Examples")]),e._v(" "),a("p",[e._v("Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain. It uses the [[ApiRx]] interface.")]),e._v(" "),a("h2",{attrs:{id:"prerequisites"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites","aria-hidden":"true"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),a("p",[e._v("For the following examples, you need a local node. It is usually convenient testing with:")]),e._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("substrate --dev\n")])]),e._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[e._v("1")]),a("br")])]),a("h2",{attrs:{id:"running-the-examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#running-the-examples","aria-hidden":"true"}},[e._v("#")]),e._v(" Running the examples")]),e._v(" "),a("p",[e._v("From each folder, run "),a("code",[e._v("yarn")]),e._v(" to install the required dependencies and then run "),a("code",[e._v("yarn start")]),e._v(" to execute the example against the running node.")]),e._v(" "),a("h2",{attrs:{id:"development-accounts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#development-accounts","aria-hidden":"true"}},[e._v("#")]),e._v(" Development accounts")]),e._v(" "),a("p",[e._v("Some of the examples use the following accounts:")]),e._v(" "),a("ul",[a("li",[e._v("Alice: "),a("code",[e._v("5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ")])]),e._v(" "),a("li",[e._v("Bob: "),a("code",[e._v("5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE")])])]),e._v(" "),a("p",[e._v("Those accounts are easy to add if you don't have/see them. The seed of Alice's account is "),a("code",[e._v("Alice␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣")]),e._v(" and the seed of Bob is... well you guess...")]),e._v(" "),a("p",[e._v("NOTE: Note the spaces padding Alice's key up to 32 chars.")])])},[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/99.6746c5ca.js b/docs/assets/js/99.6746c5ca.js deleted file mode 100644 index 1d31c6f59c..0000000000 --- a/docs/assets/js/99.6746c5ca.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[99],{454:function(t,s,a){"use strict";a.r(s);var n=a(46),e=Object(n.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"polkadot-rpc-core"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#polkadot-rpc-core","aria-hidden":"true"}},[t._v("#")]),t._v(" @polkadot/rpc-core")]),t._v(" "),a("p",[t._v("This library provides a clean wrapper around all the methods exposed by a Polkadot network client.")]),t._v(" "),a("h2",{attrs:{id:"usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#usage","aria-hidden":"true"}},[t._v("#")]),t._v(" Usage")]),t._v(" "),a("p",[t._v("Installation -")]),t._v(" "),a("div",{staticClass:"language- line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("yarn add @polkadot/rpc-core\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br")])]),a("p",[t._v("Initialisation -")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Rpc "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/rpc-core'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" WsProvider "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/rpc-provider/ws'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" provider "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("WsProvider")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'http://127.0.0.1:9944'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" api "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Rpc")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("provider"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[t._v("Retrieving the block header object for a given block header hash (a 0x-prefixed hex string with length of 64) -")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getHeader")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0x1234567890'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br")])]),a("p",[t._v("Retrieving the best block number, parent hash, state root hash, extrinsics root hash, and digest (once-off) -")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("headerHash"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getHeader")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("headerHash"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`best #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`parentHash: ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parentHash"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`stateRoot: ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("stateRoot"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`extrinsicsRoot: ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("extrinsicsRoot"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`digest: ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("digest"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'error:'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br"),a("span",{staticClass:"line-number"},[t._v("13")]),a("br"),a("span",{staticClass:"line-number"},[t._v("14")]),a("br"),a("span",{staticClass:"line-number"},[t._v("15")]),a("br")])]),a("p",[t._v("Retrieving best header via subscription -")]),t._v(" "),a("div",{staticClass:"language-js line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-js"}},[a("code",[t._v("api"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chain\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("subscribeNewHead")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`best #")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("header"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blockNumber"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("subscriptionId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token template-string"}},[a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`subscriptionId: ")]),a("span",{pre:!0,attrs:{class:"token interpolation"}},[a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("subscriptionId"),a("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("`")])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// id for the subscription, can unsubscribe via")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// api.chain.subscribeNewHead.unsubscribe(subscriptionId);")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'error subscribing:'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" error"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br"),a("span",{staticClass:"line-number"},[t._v("6")]),a("br"),a("span",{staticClass:"line-number"},[t._v("7")]),a("br"),a("span",{staticClass:"line-number"},[t._v("8")]),a("br"),a("span",{staticClass:"line-number"},[t._v("9")]),a("br"),a("span",{staticClass:"line-number"},[t._v("10")]),a("br"),a("span",{staticClass:"line-number"},[t._v("11")]),a("br"),a("span",{staticClass:"line-number"},[t._v("12")]),a("br")])]),a("h2",{attrs:{id:"classes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#classes","aria-hidden":"true"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),a("p",[a("router-link",{attrs:{to:"/rpc-core/SUMMARY.html"}},[t._v("Classes")])],1)])},[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/assets/js/app.ea488efd.js b/docs/assets/js/app.ea488efd.js deleted file mode 100644 index b8a3bce4c3..0000000000 --- a/docs/assets/js/app.ea488efd.js +++ /dev/null @@ -1,8 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(e){function t(t){for(var s,r,a=t[0],u=t[1],o=t[2],g=0,c=[];g0?i(s(e),9007199254740991):0}},function(e,t){var l=e.exports={version:"2.6.5"};"number"==typeof __e&&(__e=l)},function(e,t){var l={}.toString;e.exports=function(e){return l.call(e).slice(8,-1)}},function(e,t,l){var s=l(67);e.exports=function(e){return Object(s(e))}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){try{return!!e()}catch(e){return!0}}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,l){var s=l(11),i=l(136),n=l(137),r=Object.defineProperty;t.f=l(21)?Object.defineProperty:function(e,t,l){if(s(e),t=n(t,!0),s(l),i)try{return r(e,t,l)}catch(e){}if("get"in l||"set"in l)throw TypeError("Accessors not supported!");return"value"in l&&(e[t]=l.value),e}},function(e,t,l){var s=l(5),i=l(17),n=l(48),r=l(71)("src"),a=l(150),u=(""+a).split("toString");l(23).inspectSource=function(e){return a.call(e)},(e.exports=function(e,t,l,a){var o="function"==typeof l;o&&(n(l,"name")||i(l,"name",t)),e[t]!==l&&(o&&(n(l,r)||i(l,r,e[t]?""+e[t]:u.join(String(t)))),e===s?e[t]=l:a?e[t]?e[t]=l:i(e,t,l):(delete e[t],i(e,t,l)))})(Function.prototype,"toString",function(){return"function"==typeof this&&this[r]||a.call(this)})},function(e,t,l){var s=l(33);e.exports=function(e,t,l){if(s(e),void 0===t)return e;switch(l){case 1:return function(l){return e.call(t,l)};case 2:return function(l,s){return e.call(t,l,s)};case 3:return function(l,s,i){return e.call(t,l,s,i)}}return function(){return e.apply(t,arguments)}}},function(e,t){e.exports={}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t,l){var s=l(28);e.exports=function(e){return Object(s(e))}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t,l){var s=l(108),i=l(83);e.exports=Object.keys||function(e){return s(e,i)}},function(e,t){var l={}.toString;e.exports=function(e){return l.call(e).slice(8,-1)}},function(e,t){e.exports=!0},function(e,t,l){"use strict";var s=l(195)(!0);l(88)(String,"String",function(e){this._t=String(e),this._i=0},function(){var e,t=this._t,l=this._i;return l>=t.length?{value:void 0,done:!0}:(e=s(t,l),this._i+=e.length,{value:e,done:!1})})},function(e,t,l){var s=l(7).f,i=l(18),n=l(4)("toStringTag");e.exports=function(e,t,l){e&&!i(e=l?e:e.prototype,n)&&s(e,n,{configurable:!0,value:t})}},function(e,t,l){var s=l(12),i=l(115),n=l(116),r=l(9),a=l(51),u=l(117),o={},v={};(t=e.exports=function(e,t,l,g,c){var d,h,p,m,f=c?function(){return e}:u(e),y=s(l,g,t?2:1),_=0;if("function"!=typeof f)throw TypeError(e+" is not iterable!");if(n(f)){for(d=a(e.length);d>_;_++)if((m=t?y(r(h=e[_])[0],h[1]):y(e[_]))===o||m===v)return m}else for(p=f.call(e);!(h=p.next()).done;)if((m=i(p,y,h.value,t))===o||m===v)return m}).BREAK=o,t.RETURN=v},function(e,t,l){e.exports=l(185)},function(e,t,l){e.exports=l(189)},function(e,t,l){e.exports=l(213)},function(e,t,l){"use strict";function s(e,t,l,s,i,n,r,a){var u,o="function"==typeof e?e.options:e;if(t&&(o.render=t,o.staticRenderFns=l,o._compiled=!0),s&&(o.functional=!0),n&&(o._scopeId="data-v-"+n),r?(u=function(e){(e=e||this.$vnode&&this.$vnode.ssrContext||this.parent&&this.parent.$vnode&&this.parent.$vnode.ssrContext)||"undefined"==typeof __VUE_SSR_CONTEXT__||(e=__VUE_SSR_CONTEXT__),i&&i.call(this,e),e&&e._registeredComponents&&e._registeredComponents.add(r)},o._ssrRegister=u):i&&(u=a?function(){i.call(this,this.$root.$options.shadowRoot)}:i),u)if(o.functional){o._injectStyles=u;var v=o.render;o.render=function(e,t){return u.call(t),v(e,t)}}else{var g=o.beforeCreate;o.beforeCreate=g?[].concat(g,u):[u]}return{exports:e,options:o}}l.d(t,"a",function(){return s})},function(e,t,l){"use strict";var s=l(27);e.exports=function(e,t){return!!e&&s(function(){t?e.call(null,function(){},1):e.call(null)})}},function(e,t){var l={}.hasOwnProperty;e.exports=function(e,t){return l.call(e,t)}},function(e,t,l){var s=l(24);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==s(e)?e.split(""):Object(e)}},function(e,t){var l=Math.ceil,s=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?s:l)(e)}},function(e,t,l){var s=l(80),i=Math.min;e.exports=function(e){return e>0?i(s(e),9007199254740991):0}},function(e,t){var l=0,s=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++l+s).toString(36))}},function(e,t){t.f=Object.getOwnPropertySymbols},function(e,t){t.f={}.propertyIsEnumerable},function(e,t,l){for(var s=l(100),i=l(73),n=l(30),r=l(5),a=l(17),u=l(32),o=l(2),v=o("iterator"),g=o("toStringTag"),c=u.Array,d={CSSRuleList:!0,CSSStyleDeclaration:!1,CSSValueList:!1,ClientRectList:!1,DOMRectList:!1,DOMStringList:!1,DOMTokenList:!0,DataTransferItemList:!1,FileList:!1,HTMLAllCollection:!1,HTMLCollection:!1,HTMLFormElement:!1,HTMLSelectElement:!1,MediaList:!0,MimeTypeArray:!1,NamedNodeMap:!1,NodeList:!0,PaintRequestList:!1,Plugin:!1,PluginArray:!1,SVGLengthList:!1,SVGNumberList:!1,SVGPathSegList:!1,SVGPointList:!1,SVGStringList:!1,SVGTransformList:!1,SourceBufferList:!1,StyleSheetList:!0,TextTrackCueList:!1,TextTrackList:!1,TouchList:!1},h=i(d),p=0;pdocument.F=Object<\/script>"),e.close(),u=e.F;s--;)delete u.prototype[n[s]];return u()};e.exports=Object.create||function(e,t){var l;return null!==e?(a.prototype=s(e),l=new a,a.prototype=null,l[r]=e):l=u(),void 0===t?l:i(l,t)}},function(e,t,l){l(198);for(var s=l(3),i=l(14),n=l(26),r=l(4)("toStringTag"),a="CSSRuleList,CSSStyleDeclaration,CSSValueList,ClientRectList,DOMRectList,DOMStringList,DOMTokenList,DataTransferItemList,FileList,HTMLAllCollection,HTMLCollection,HTMLFormElement,HTMLSelectElement,MediaList,MimeTypeArray,NamedNodeMap,NodeList,PaintRequestList,Plugin,PluginArray,SVGLengthList,SVGNumberList,SVGPathSegList,SVGPointList,SVGStringList,SVGTransformList,SourceBufferList,StyleSheetList,TextTrackCueList,TextTrackList,TouchList".split(","),u=0;u
'};function i(e,t,l){return el?l:e}function n(e){return 100*(-1+e)}l.configure=function(e){var t,l;for(t in e)void 0!==(l=e[t])&&e.hasOwnProperty(t)&&(s[t]=l);return this},l.status=null,l.set=function(e){var t=l.isStarted();e=i(e,s.minimum,1),l.status=1===e?null:e;var u=l.render(!t),o=u.querySelector(s.barSelector),v=s.speed,g=s.easing;return u.offsetWidth,r(function(t){""===s.positionUsing&&(s.positionUsing=l.getPositioningCSS()),a(o,function(e,t,l){var i;return(i="translate3d"===s.positionUsing?{transform:"translate3d("+n(e)+"%,0,0)"}:"translate"===s.positionUsing?{transform:"translate("+n(e)+"%,0)"}:{"margin-left":n(e)+"%"}).transition="all "+t+"ms "+l,i}(e,v,g)),1===e?(a(u,{transition:"none",opacity:1}),u.offsetWidth,setTimeout(function(){a(u,{transition:"all "+v+"ms linear",opacity:0}),setTimeout(function(){l.remove(),t()},v)},v)):setTimeout(t,v)}),this},l.isStarted=function(){return"number"==typeof l.status},l.start=function(){l.status||l.set(0);var e=function(){setTimeout(function(){l.status&&(l.trickle(),e())},s.trickleSpeed)};return s.trickle&&e(),this},l.done=function(e){return e||l.status?l.inc(.3+.5*Math.random()).set(1):this},l.inc=function(e){var t=l.status;return t?("number"!=typeof e&&(e=(1-t)*i(Math.random()*t,.1,.95)),t=i(t+e,0,.994),l.set(t)):l.start()},l.trickle=function(){return l.inc(Math.random()*s.trickleRate)},e=0,t=0,l.promise=function(s){return s&&"resolved"!==s.state()?(0===t&&l.start(),e++,t++,s.always(function(){0==--t?(e=0,l.done()):l.set((e-t)/e)}),this):this},l.render=function(e){if(l.isRendered())return document.getElementById("nprogress");o(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=s.template;var i,r=t.querySelector(s.barSelector),u=e?"-100":n(l.status||0),v=document.querySelector(s.parent);return a(r,{transition:"all 0 linear",transform:"translate3d("+u+"%,0,0)"}),s.showSpinner||(i=t.querySelector(s.spinnerSelector))&&c(i),v!=document.body&&o(v,"nprogress-custom-parent"),v.appendChild(t),t},l.remove=function(){v(document.documentElement,"nprogress-busy"),v(document.querySelector(s.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&c(e)},l.isRendered=function(){return!!document.getElementById("nprogress")},l.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var r=function(){var e=[];function t(){var l=e.shift();l&&l(t)}return function(l){e.push(l),1==e.length&&t()}}(),a=function(){var e=["Webkit","O","Moz","ms"],t={};function l(l){return l=l.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,function(e,t){return t.toUpperCase()}),t[l]||(t[l]=function(t){var l=document.body.style;if(t in l)return t;for(var s,i=e.length,n=t.charAt(0).toUpperCase()+t.slice(1);i--;)if((s=e[i]+n)in l)return s;return t}(l))}function s(e,t,s){t=l(t),e.style[t]=s}return function(e,t){var l,i,n=arguments;if(2==n.length)for(l in t)void 0!==(i=t[l])&&t.hasOwnProperty(l)&&s(e,l,i);else s(e,n[1],n[2])}}();function u(e,t){var l="string"==typeof e?e:g(e);return l.indexOf(" "+t+" ")>=0}function o(e,t){var l=g(e),s=l+t;u(l,t)||(e.className=s.substring(1))}function v(e,t){var l,s=g(e);u(e,t)&&(l=s.replace(" "+t+" "," "),e.className=l.substring(1,l.length-1))}function g(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function c(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return l})?s.call(t,l,t,e):s)||(e.exports=i)},function(e,t,l){"use strict";var s=l(8),i=l(66)(1);s(s.P+s.F*!l(47)([].map,!0),"Array",{map:function(e){return i(this,e,arguments[1])}})},function(e,t,l){var s=l(49),i=l(28);e.exports=function(e){return s(i(e))}},function(e,t,l){var s=l(31),i=l(49),n=l(34),r=l(22),a=l(172);e.exports=function(e,t){var l=1==e,u=2==e,o=3==e,v=4==e,g=6==e,c=5==e||g,d=t||a;return function(t,a,h){for(var p,m,f=n(t),y=i(f),_=s(a,h,3),b=r(y.length),x=0,S=l?d(t,b):u?d(t,0):void 0;b>x;x++)if((c||x in y)&&(m=_(p=y[x],x,f),e))if(l)S[x]=m;else if(m)switch(e){case 3:return!0;case 5:return p;case 6:return x;case 2:S.push(p)}else if(v)return!1;return g?-1:o||v?v:S}}},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,l){"use strict";var s=l(8),i=l(66)(2);s(s.P+s.F*!l(47)([].filter,!0),"Array",{filter:function(e){return i(this,e,arguments[1])}})},function(e,t,l){var s=l(23),i=l(5),n=i["__core-js_shared__"]||(i["__core-js_shared__"]={});(e.exports=function(e,t){return n[e]||(n[e]=void 0!==t?t:{})})("versions",[]).push({version:s.version,mode:l(70)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports=!1},function(e,t){var l=0,s=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++l+s).toString(36))}},function(e,t,l){var s=l(15),i=l(5).document,n=s(i)&&s(i.createElement);e.exports=function(e){return n?i.createElement(e):{}}},function(e,t,l){var s=l(138),i=l(99);e.exports=Object.keys||function(e){return s(e,i)}},function(e,t,l){var s=l(69)("keys"),i=l(71);e.exports=function(e){return s[e]||(s[e]=i(e))}},function(e,t,l){var s=l(29).f,i=l(48),n=l(2)("toStringTag");e.exports=function(e,t,l){e&&!i(e=l?e:e.prototype,n)&&s(e,n,{configurable:!0,value:t})}},function(e,t,l){var s=l(24),i=l(2)("toStringTag"),n="Arguments"==s(function(){return arguments}());e.exports=function(e){var t,l,r;return void 0===e?"Undefined":null===e?"Null":"string"==typeof(l=function(e,t){try{return e[t]}catch(e){}}(t=Object(e),i))?l:n?s(t):"Object"==(r=s(t))&&"function"==typeof t.callee?"Arguments":r}},function(e,t,l){var s=l(6),i=l(3).document,n=s(i)&&s(i.createElement);e.exports=function(e){return n?i.createElement(e):{}}},function(e,t,l){var s=l(6);e.exports=function(e,t){if(!s(e))return e;var l,i;if(t&&"function"==typeof(l=e.toString)&&!s(i=l.call(e)))return i;if("function"==typeof(l=e.valueOf)&&!s(i=l.call(e)))return i;if(!t&&"function"==typeof(l=e.toString)&&!s(i=l.call(e)))return i;throw TypeError("Can't convert object to primitive value")}},function(e,t,l){var s=l(38);e.exports=Object("z").propertyIsEnumerable(0)?Object:function(e){return"String"==s(e)?e.split(""):Object(e)}},function(e,t){var l=Math.ceil,s=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?s:l)(e)}},function(e,t,l){var s=l(82)("keys"),i=l(52);e.exports=function(e){return s[e]||(s[e]=i(e))}},function(e,t,l){var s=l(0),i=l(3),n=i["__core-js_shared__"]||(i["__core-js_shared__"]={});(e.exports=function(e,t){return n[e]||(n[e]=void 0!==t?t:{})})("versions",[]).push({version:s.version,mode:l(39)?"pure":"global",copyright:"© 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,l){"use strict";var s=l(8),i=l(66)(0),n=l(47)([].forEach,!0);s(s.P+s.F*!n,"Array",{forEach:function(e){return i(this,e,arguments[1])}})},function(e,t,l){var s=l(1),i=l(0),n=l(16);e.exports=function(e,t){var l=(i.Object||{})[e]||Object[e],r={};r[e]=t(l),s(s.S+s.F*n(function(){l(1)}),"Object",r)}},function(e,t,l){var s=l(108),i=l(83).concat("length","prototype");t.f=Object.getOwnPropertyNames||function(e){return s(e,i)}},function(e,t,l){var s=l(54),i=l(36),n=l(19),r=l(78),a=l(18),u=l(107),o=Object.getOwnPropertyDescriptor;t.f=l(10)?o:function(e,t){if(e=n(e),t=r(t,!0),u)try{return o(e,t)}catch(e){}if(a(e,t))return i(!s.f.call(e,t),e[t])}},function(e,t,l){"use strict";var s=l(39),i=l(1),n=l(111),r=l(14),a=l(26),u=l(196),o=l(41),v=l(109),g=l(4)("iterator"),c=!([].keys&&"next"in[].keys()),d=function(){return this};e.exports=function(e,t,l,h,p,m,f){u(l,t,h);var y,_,b,x=function(e){if(!c&&e in L)return L[e];switch(e){case"keys":case"values":return function(){return new l(this,e)}}return function(){return new l(this,e)}},S=t+" Iterator",k="values"==p,E=!1,L=e.prototype,w=L[g]||L["@@iterator"]||p&&L[p],O=w||x(p),P=p?k?x("entries"):O:void 0,T="Array"==t&&L.entries||w;if(T&&(b=v(T.call(new e)))!==Object.prototype&&b.next&&(o(b,S,!0),s||"function"==typeof b[g]||r(b,g,d)),k&&w&&"values"!==w.name&&(E=!0,O=function(){return w.call(this)}),s&&!f||!c&&!E&&L[g]||r(L,g,O),a[t]=O,a[S]=d,p)if(y={values:k?O:x("values"),keys:m?O:x("keys"),entries:P},f)for(_ in y)_ in L||n(L,_,y[_]);else i(i.P+i.F*(c||E),t,y);return y}},function(e,t,l){t.f=l(4)},function(e,t,l){var s=l(3),i=l(0),n=l(39),r=l(89),a=l(7).f;e.exports=function(e){var t=i.Symbol||(i.Symbol=n?{}:s.Symbol||{});"_"==e.charAt(0)||e in t||a(t,e,{value:r.f(e)})}},function(e,t,l){var s=l(38);e.exports=Array.isArray||function(e){return"Array"==s(e)}},function(e,t){},function(e,t){e.exports=function(e,t,l,s){if(!(e instanceof t)||void 0!==s&&s in e)throw TypeError(l+": incorrect invocation!");return e}},function(e,t,l){"use strict";var s=l(35);function i(e){var t,l;this.promise=new e(function(e,s){if(void 0!==t||void 0!==l)throw TypeError("Bad Promise constructor");t=e,l=s}),this.resolve=s(t),this.reject=s(l)}e.exports.f=function(e){return new i(e)}},function(e,t,l){var s=l(14);e.exports=function(e,t,l){for(var i in t)l&&e[i]?e[i]=t[i]:s(e,i,t[i]);return e}},function(e,t,l){e.exports=l(194)},function(e,t,l){e.exports=l(221)},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,l){"use strict";var s=l(148),i=l(149),n=l(32),r=l(65);e.exports=l(101)(Array,"Array",function(e,t){this._t=r(e),this._i=0,this._k=t},function(){var e=this._t,t=this._k,l=this._i++;return!e||l>=e.length?(this._t=void 0,i(1)):i(0,"keys"==t?l:"values"==t?e[l]:[l,e[l]])},"values"),n.Arguments=n.Array,s("keys"),s("values"),s("entries")},function(e,t,l){"use strict";var s=l(70),i=l(8),n=l(30),r=l(17),a=l(32),u=l(151),o=l(75),v=l(155),g=l(2)("iterator"),c=!([].keys&&"next"in[].keys()),d=function(){return this};e.exports=function(e,t,l,h,p,m,f){u(l,t,h);var y,_,b,x=function(e){if(!c&&e in L)return L[e];switch(e){case"keys":case"values":return function(){return new l(this,e)}}return function(){return new l(this,e)}},S=t+" Iterator",k="values"==p,E=!1,L=e.prototype,w=L[g]||L["@@iterator"]||p&&L[p],O=w||x(p),P=p?k?x("entries"):O:void 0,T="Array"==t&&L.entries||w;if(T&&(b=v(T.call(new e)))!==Object.prototype&&b.next&&(o(b,S,!0),s||"function"==typeof b[g]||r(b,g,d)),k&&w&&"values"!==w.name&&(E=!0,O=function(){return w.call(this)}),s&&!f||!c&&!E&&L[g]||r(L,g,O),a[t]=O,a[S]=d,p)if(y={values:k?O:x("values"),keys:m?O:x("keys"),entries:P},f)for(_ in y)_ in L||n(L,_,y[_]);else i(i.P+i.F*(c||E),t,y);return y}},function(e,t,l){var s=l(5).document;e.exports=s&&s.documentElement},function(e,t,l){var s=l(11),i=l(33),n=l(2)("species");e.exports=function(e,t){var l,r=s(e).constructor;return void 0===r||null==(l=s(r)[n])?t:i(l)}},function(e,t,l){var s,i,n,r=l(31),a=l(162),u=l(102),o=l(72),v=l(5),g=v.process,c=v.setImmediate,d=v.clearImmediate,h=v.MessageChannel,p=v.Dispatch,m=0,f={},y=function(){var e=+this;if(f.hasOwnProperty(e)){var t=f[e];delete f[e],t()}},_=function(e){y.call(e.data)};c&&d||(c=function(e){for(var t=[],l=1;arguments.length>l;)t.push(arguments[l++]);return f[++m]=function(){a("function"==typeof e?e:Function(e),t)},s(m),m},d=function(e){delete f[e]},"process"==l(24)(g)?s=function(e){g.nextTick(r(y,e,1))}:p&&p.now?s=function(e){p.now(r(y,e,1))}:h?(n=(i=new h).port2,i.port1.onmessage=_,s=r(n.postMessage,n,1)):v.addEventListener&&"function"==typeof postMessage&&!v.importScripts?(s=function(e){v.postMessage(e+"","*")},v.addEventListener("message",_,!1)):s="onreadystatechange"in o("script")?function(e){u.appendChild(o("script")).onreadystatechange=function(){u.removeChild(this),y.call(e)}}:function(e){setTimeout(r(y,e,1),0)}),e.exports={set:c,clear:d}},function(e,t,l){"use strict";var s=l(33);function i(e){var t,l;this.promise=new e(function(e,s){if(void 0!==t||void 0!==l)throw TypeError("Bad Promise constructor");t=e,l=s}),this.resolve=s(t),this.reject=s(l)}e.exports.f=function(e){return new i(e)}},function(e,t,l){var s=l(11),i=l(15),n=l(105);e.exports=function(e,t){if(s(e),i(t)&&t.constructor===e)return t;var l=n.f(e);return(0,l.resolve)(t),l.promise}},function(e,t,l){e.exports=!l(10)&&!l(16)(function(){return 7!=Object.defineProperty(l(77)("div"),"a",{get:function(){return 7}}).a})},function(e,t,l){var s=l(18),i=l(19),n=l(178)(!1),r=l(81)("IE_PROTO");e.exports=function(e,t){var l,a=i(e),u=0,o=[];for(l in a)l!=r&&s(a,l)&&o.push(l);for(;t.length>u;)s(a,l=t[u++])&&(~n(o,l)||o.push(l));return o}},function(e,t,l){var s=l(18),i=l(25),n=l(81)("IE_PROTO"),r=Object.prototype;e.exports=Object.getPrototypeOf||function(e){return e=i(e),s(e,n)?e[n]:"function"==typeof e.constructor&&e instanceof e.constructor?e.constructor.prototype:e instanceof Object?r:null}},function(e,t,l){"use strict";var s=l(7),i=l(36);e.exports=function(e,t,l){t in e?s.f(e,t,i(0,l)):e[t]=l}},function(e,t,l){e.exports=l(14)},function(e,t,l){var s=l(3).document;e.exports=s&&s.documentElement},function(e,t){e.exports=function(e,t){return{value:t,done:!!e}}},function(e,t,l){e.exports=l(206)},function(e,t,l){var s=l(9);e.exports=function(e,t,l,i){try{return i?t(s(l)[0],l[1]):t(l)}catch(t){var n=e.return;throw void 0!==n&&s(n.call(e)),t}}},function(e,t,l){var s=l(26),i=l(4)("iterator"),n=Array.prototype;e.exports=function(e){return void 0!==e&&(s.Array===e||n[i]===e)}},function(e,t,l){var s=l(59),i=l(4)("iterator"),n=l(26);e.exports=l(0).getIteratorMethod=function(e){if(null!=e)return e[i]||e["@@iterator"]||n[s(e)]}},function(e,t,l){var s=l(4)("iterator"),i=!1;try{var n=[7][s]();n.return=function(){i=!0},Array.from(n,function(){throw 2})}catch(e){}e.exports=function(e,t){if(!t&&!i)return!1;var l=!1;try{var n=[7],r=n[s]();r.next=function(){return{done:l=!0}},n[s]=function(){return r},e(n)}catch(e){}return l}},function(e,t,l){var s=l(29).f,i=Function.prototype,n=/^\s*function ([^ (]*)/;"name"in i||l(21)&&s(i,"name",{configurable:!0,get:function(){try{return(""+this).match(n)[1]}catch(e){return""}}})},function(e,t,l){var s=l(9),i=l(35),n=l(4)("species");e.exports=function(e,t){var l,r=s(e).constructor;return void 0===r||null==(l=s(r)[n])?t:i(l)}},function(e,t,l){var s,i,n,r=l(12),a=l(215),u=l(112),o=l(77),v=l(3),g=v.process,c=v.setImmediate,d=v.clearImmediate,h=v.MessageChannel,p=v.Dispatch,m=0,f={},y=function(){var e=+this;if(f.hasOwnProperty(e)){var t=f[e];delete f[e],t()}},_=function(e){y.call(e.data)};c&&d||(c=function(e){for(var t=[],l=1;arguments.length>l;)t.push(arguments[l++]);return f[++m]=function(){a("function"==typeof e?e:Function(e),t)},s(m),m},d=function(e){delete f[e]},"process"==l(38)(g)?s=function(e){g.nextTick(r(y,e,1))}:p&&p.now?s=function(e){p.now(r(y,e,1))}:h?(n=(i=new h).port2,i.port1.onmessage=_,s=r(n.postMessage,n,1)):v.addEventListener&&"function"==typeof postMessage&&!v.importScripts?(s=function(e){v.postMessage(e+"","*")},v.addEventListener("message",_,!1)):s="onreadystatechange"in o("script")?function(e){u.appendChild(o("script")).onreadystatechange=function(){u.removeChild(this),y.call(e)}}:function(e){setTimeout(r(y,e,1),0)}),e.exports={set:c,clear:d}},function(e,t){e.exports=function(e){try{return{e:!1,v:e()}}catch(e){return{e:!0,v:e}}}},function(e,t,l){var s=l(9),i=l(6),n=l(94);e.exports=function(e,t){if(s(e),i(t)&&t.constructor===e)return t;var l=n.f(e);return(0,l.resolve)(t),l.promise}},function(e,t,l){"use strict";var s=l(3),i=l(0),n=l(7),r=l(10),a=l(4)("species");e.exports=function(e){var t="function"==typeof i[e]?i[e]:s[e];r&&t&&!t[a]&&n.f(t,a,{configurable:!0,get:function(){return this}})}},function(e,t,l){var s=l(50),i=l(28);e.exports=function(e){return function(t,l){var n,r,a=String(i(t)),u=s(l),o=a.length;return u<0||u>=o?e?"":void 0:(n=a.charCodeAt(u))<55296||n>56319||u+1===o||(r=a.charCodeAt(u+1))<56320||r>57343?e?a.charAt(u):n:e?a.slice(u,u+2):r-56320+(n-55296<<10)+65536}}},function(e,t,l){var s=l(6);e.exports=function(e,t){if(!s(e)||e._t!==t)throw TypeError("Incompatible receiver, "+t+" required!");return e}},function(e,t,l){"use strict";var s,i,n=l(146),r=RegExp.prototype.exec,a=String.prototype.replace,u=r,o=(s=/a/,i=/b*/g,r.call(s,"a"),r.call(i,"a"),0!==s.lastIndex||0!==i.lastIndex),v=void 0!==/()??/.exec("")[1];(o||v)&&(u=function(e){var t,l,s,i,u=this;return v&&(l=new RegExp("^"+u.source+"$(?!\\s)",n.call(u))),o&&(t=u.lastIndex),s=r.call(u,e),o&&s&&(u.lastIndex=u.global?s.index+s[0].length:t),v&&s&&s.length>1&&a.call(s[0],l,function(){for(i=1;i=t||l<0||c&&e-v>=r}function x(){var e=m();if(b(e))return S(e);u=setTimeout(x,function(e){var l=t-(e-o);return c?p(l,r-(e-v)):l}(e))}function S(e){return u=void 0,d&&i?f(e):(i=n=void 0,a)}function k(){var e=m(),l=b(e);if(i=arguments,n=this,o=e,l){if(void 0===u)return function(e){return v=e,u=setTimeout(x,t),g?f(e):a}(o);if(c)return u=setTimeout(x,t),f(o)}return void 0===u&&(u=setTimeout(x,t)),a}return t=_(t)||0,y(s)&&(g=!!s.leading,r=(c="maxWait"in s)?h(_(s.maxWait)||0,t):r,d="trailing"in s?!!s.trailing:d),k.cancel=function(){void 0!==u&&clearTimeout(u),v=0,i=o=n=u=void 0},k.flush=function(){return void 0===u?a:S(m())},k}function y(e){var t=typeof e;return!!e&&("object"==t||"function"==t)}function _(e){if("number"==typeof e)return e;if(function(e){return"symbol"==typeof e||function(e){return!!e&&"object"==typeof e}(e)&&d.call(e)==i}(e))return s;if(y(e)){var t="function"==typeof e.valueOf?e.valueOf():e;e=y(t)?t+"":t}if("string"!=typeof e)return 0===e?e:+e;e=e.replace(n,"");var l=a.test(e);return l||u.test(e)?o(e.slice(2),l?2:8):r.test(e)?s:+e}e.exports=function(e,t,s){var i=!0,n=!0;if("function"!=typeof e)throw new TypeError(l);return y(s)&&(i="leading"in s?!!s.leading:i,n="trailing"in s?!!s.trailing:n),f(e,t,{leading:i,maxWait:t,trailing:n})}},function(e,t,l){e.exports=l(240)},function(e,t,l){e.exports=l(242)},function(e,t,l){"use strict";var s=l(11),i=l(34),n=l(22),r=l(50),a=l(143),u=l(144),o=Math.max,v=Math.min,g=Math.floor,c=/\$([$&`']|\d\d?|<[^>]*>)/g,d=/\$([$&`']|\d\d?)/g;l(145)("replace",2,function(e,t,l,h){return[function(s,i){var n=e(this),r=null==s?void 0:s[t];return void 0!==r?r.call(s,n,i):l.call(String(n),s,i)},function(e,t){var i=h(l,e,this,t);if(i.done)return i.value;var g=s(e),c=String(this),d="function"==typeof t;d||(t=String(t));var m=g.global;if(m){var f=g.unicode;g.lastIndex=0}for(var y=[];;){var _=u(g,c);if(null===_)break;if(y.push(_),!m)break;""===String(_[0])&&(g.lastIndex=a(c,n(g.lastIndex),f))}for(var b,x="",S=0,k=0;k=S&&(x+=c.slice(S,L)+q,S=L+E.length)}return x+c.slice(S)}];function p(e,t,s,n,r,a){var u=s+e.length,o=n.length,v=d;return void 0!==r&&(r=i(r),v=c),l.call(a,v,function(l,i){var a;switch(i.charAt(0)){case"$":return"$";case"&":return e;case"`":return t.slice(0,s);case"'":return t.slice(u);case"<":a=r[i.slice(1,-1)];break;default:var v=+i;if(0===v)return l;if(v>o){var c=g(v/10);return 0===c?l:c<=o?void 0===n[c-1]?i.charAt(1):n[c-1]+i.charAt(1):l}a=n[v-1]}return void 0===a?"":a})}})},function(e,t,l){e.exports=!l(21)&&!l(27)(function(){return 7!=Object.defineProperty(l(72)("div"),"a",{get:function(){return 7}}).a})},function(e,t,l){var s=l(15);e.exports=function(e,t){if(!s(e))return e;var l,i;if(t&&"function"==typeof(l=e.toString)&&!s(i=l.call(e)))return i;if("function"==typeof(l=e.valueOf)&&!s(i=l.call(e)))return i;if(!t&&"function"==typeof(l=e.toString)&&!s(i=l.call(e)))return i;throw TypeError("Can't convert object to primitive value")}},function(e,t,l){var s=l(48),i=l(65),n=l(139)(!1),r=l(74)("IE_PROTO");e.exports=function(e,t){var l,a=i(e),u=0,o=[];for(l in a)l!=r&&s(a,l)&&o.push(l);for(;t.length>u;)s(a,l=t[u++])&&(~n(o,l)||o.push(l));return o}},function(e,t,l){var s=l(65),i=l(22),n=l(154);e.exports=function(e){return function(t,l,r){var a,u=s(t),o=i(u.length),v=n(r,o);if(e&&l!=l){for(;o>v;)if((a=u[v++])!=a)return!0}else for(;o>v;v++)if((e||v in u)&&u[v]===l)return e||v||0;return!e&&-1}}},function(e,t,l){"use strict";var s=l(5),i=l(29),n=l(21),r=l(2)("species");e.exports=function(e){var t=s[e];n&&t&&!t[r]&&i.f(t,r,{configurable:!0,get:function(){return this}})}},function(e,t){t.f={}.propertyIsEnumerable},function(e,t,l){var s=l(15),i=l(24),n=l(2)("match");e.exports=function(e){var t;return s(e)&&(void 0!==(t=e[n])?!!t:"RegExp"==i(e))}},function(e,t,l){"use strict";var s=l(125)(!0);e.exports=function(e,t,l){return t+(l?s(e,t).length:1)}},function(e,t,l){"use strict";var s=l(76),i=RegExp.prototype.exec;e.exports=function(e,t){var l=e.exec;if("function"==typeof l){var n=l.call(e,t);if("object"!=typeof n)throw new TypeError("RegExp exec method returned something other than an Object or null");return n}if("RegExp"!==s(e))throw new TypeError("RegExp#exec called on incompatible receiver");return i.call(e,t)}},function(e,t,l){"use strict";l(244);var s=l(30),i=l(17),n=l(27),r=l(28),a=l(2),u=l(127),o=a("species"),v=!n(function(){var e=/./;return e.exec=function(){var e=[];return e.groups={a:"7"},e},"7"!=="".replace(e,"$")}),g=function(){var e=/(?:)/,t=e.exec;e.exec=function(){return t.apply(this,arguments)};var l="ab".split(e);return 2===l.length&&"a"===l[0]&&"b"===l[1]}();e.exports=function(e,t,l){var c=a(e),d=!n(function(){var t={};return t[c]=function(){return 7},7!=""[e](t)}),h=d?!n(function(){var t=!1,l=/a/;return l.exec=function(){return t=!0,null},"split"===e&&(l.constructor={},l.constructor[o]=function(){return l}),l[c](""),!t}):void 0;if(!d||!h||"replace"===e&&!v||"split"===e&&!g){var p=/./[c],m=l(r,c,""[e],function(e,t,l,s,i){return t.exec===u?d&&!i?{done:!0,value:p.call(t,l,s)}:{done:!0,value:e.call(l,t,s)}:{done:!1}}),f=m[0],y=m[1];s(String.prototype,e,f),i(RegExp.prototype,c,2==t?function(e,t){return y.call(e,this,t)}:function(e){return y.call(e,this)})}}},function(e,t,l){"use strict";var s=l(11);e.exports=function(){var e=s(this),t="";return e.global&&(t+="g"),e.ignoreCase&&(t+="i"),e.multiline&&(t+="m"),e.unicode&&(t+="u"),e.sticky&&(t+="y"),t}},function(e,t,l){e.exports=l(246)},function(e,t,l){var s=l(2)("unscopables"),i=Array.prototype;null==i[s]&&l(17)(i,s,{}),e.exports=function(e){i[s][e]=!0}},function(e,t){e.exports=function(e,t){return{value:t,done:!!e}}},function(e,t,l){e.exports=l(69)("native-function-to-string",Function.toString)},function(e,t,l){"use strict";var s=l(152),i=l(98),n=l(75),r={};l(17)(r,l(2)("iterator"),function(){return this}),e.exports=function(e,t,l){e.prototype=s(r,{next:i(1,l)}),n(e,t+" Iterator")}},function(e,t,l){var s=l(11),i=l(153),n=l(99),r=l(74)("IE_PROTO"),a=function(){},u=function(){var e,t=l(72)("iframe"),s=n.length;for(t.style.display="none",l(102).appendChild(t),t.src="javascript:",(e=t.contentWindow.document).open(),e.write(" - - diff --git a/docs/examples/promise/02_listen_to_blocks/index.html b/docs/examples/promise/02_listen_to_blocks/index.html deleted file mode 100644 index c841f41475..0000000000 --- a/docs/examples/promise/02_listen_to_blocks/index.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - Listen to new blocks | polkadot-js/api - - - - - - - -
polkadot-js/api

Listen to new blocks

This example shows how to subscribe to new blocks.

It displays the block number every time a new block is seen by the node you are connected to.

NOTE: The example runs until you stop it with CTRL+C

// @ts-check
-// Import the API
-const { ApiPromise } = require('@polkadot/api');
-
-async function main () {
-  // Here we don't pass the (optional) provider, connecting directly to the default
-  // node/port, i.e. `ws://127.0.0.1:9944`. Await for the isReady promise to ensure
-  // the API has connected to the node and completed the initialisation process
-  const api = await ApiPromise.create();
-
-  // Subscribe to the new headers on-chain. The callback is fired when new headers
-  // are found, the call itself returns a promise with a subscription that can be
-  // used to unsubscribe from the newHead subscription
-  const unsubscribe = await api.rpc.chain.subscribeNewHead((header) => {
-    console.log(`Chain is at block: #${header.blockNumber}`);
-  });
-}
-
-main().catch(console.error);
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

- ← - - Listen to balance change - - → -

- - - diff --git a/docs/examples/promise/03_listen_to_balance_change/index.html b/docs/examples/promise/03_listen_to_balance_change/index.html deleted file mode 100644 index aff21a59f2..0000000000 --- a/docs/examples/promise/03_listen_to_balance_change/index.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Listen to balance changes | polkadot-js/api - - - - - - - -
polkadot-js/api

Listen to balance changes

This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.

// @ts-check
-// Import the API
-const { ApiPromise } = require('@polkadot/api');
-
-// Known account we want to use (available on dev chain, with funds)
-const Alice = '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ';
-
-async function main () {
-  // Create an await for the API
-  const api = await ApiPromise.create();
-
-  // Retrieve the initial balance. Since the call has no callback, it is simply a promise
-  // that resolves to the current on-chain value
-  let previous = await api.query.balances.freeBalance(Alice);
-
-  console.log(`${Alice} has a balance of ${previous}`);
-  console.log(`You may leave this example running and start example 06 or transfer any value to ${Alice}`);
-
-  // Here we subscribe to any balance changes and update the on-screen value
-  api.query.balances.freeBalance(Alice, (current) => {
-    // Calculate the delta
-    const change = current.sub(previous);
-
-    // Only display positive value changes (Since we are pulling `previous` above already,
-    // the initial balance change will also be zero)
-    if (!change.isZero()) {
-      previous = current;
-      console.log(`New balance change of: ${change}`);
-    }
-  });
-}
-
-main().catch(console.error);
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

- ← - - Unsubscribe from listening - - → -

- - - diff --git a/docs/examples/promise/04_unsubscribe/index.html b/docs/examples/promise/04_unsubscribe/index.html deleted file mode 100644 index 8aa5236b8e..0000000000 --- a/docs/examples/promise/04_unsubscribe/index.html +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - Unsubscribe from listening to updates | polkadot-js/api - - - - - - - -
polkadot-js/api

Unsubscribe from listening to updates

This example shows how to subscribe to and later unsubscribe from listening to block updates.

In this example we're calling the built-in unsubscribe() function after a timeOut of 20s to cleanup and unsubscribe from listening to updates.

// @ts-check
-// Import the API
-const { ApiPromise } = require('@polkadot/api');
-
-async function main () {
-
-  // Create a new instance of the api
-  const api = await ApiPromise.create();
-
-  // Subscribe to chain updates and log the current block  number on update.
-  const unsubscribe = await api.rpc.chain.subscribeNewHead((header) => {
-    console.log(`Chain is at block: #${header.blockNumber}`);
-  });
-
-  // In this example we're calling the unsubscribe() function that is being
-  // returned by the api call function after 20s.
-  setTimeout(() => {
-    unsubscribe();
-    console.log('Unsubscribed')
-  }, 20000);
-}
-
-main().catch(console.error);
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

- ← - - Read chain state - - → -

- - - diff --git a/docs/examples/promise/05_read_storage/index.html b/docs/examples/promise/05_read_storage/index.html deleted file mode 100644 index 94381d9665..0000000000 --- a/docs/examples/promise/05_read_storage/index.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Read storage | polkadot-js/api - - - - - - - -
polkadot-js/api

Read storage

Many important variables are available through the storage API. This example shows how to call a few of those APIs.

// @ts-check
-// Import the API
-const { ApiPromise } = require('@polkadot/api');
-
-// Our address for Alice on the dev chain
-const Alice = '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ';
-
-async function main () {
-  // Create our API with a default connection to the local node
-  const api = await ApiPromise.create();
-
-  // Make our basic chain state/storage queries, all in one go
-  const [accountNonce, blockPeriod, validators] = await Promise.all([
-    api.query.system.accountNonce(Alice),
-    api.query.timestamp.blockPeriod(),
-    api.query.session.validators()
-  ]);
-
-  console.log(`accountNonce(${Alice}) ${accountNonce}`);
-  console.log(`blockPeriod ${blockPeriod.toNumber()} seconds`);
-
-  if (validators && validators.length > 0) {
-    // Retrieve the balances for all validators
-    const validatorBalances = await Promise.all(
-      validators.map(authorityId =>
-        api.query.balances.freeBalance(authorityId)
-      )
-    );
-
-    // Print out the authorityIds and balances of all validators
-    console.log('validators', validators.map((authorityId, index) => ({
-      address: authorityId.toString(),
-      balance: validatorBalances[index].toString()
-    })));
-  }
-}
-
-main().catch(console.error).finally(_ => process.exit());
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

- ← - - Make a transfer - - → -

- - - diff --git a/docs/examples/promise/06_make_transfer/index.html b/docs/examples/promise/06_make_transfer/index.html deleted file mode 100644 index 072d78a3c9..0000000000 --- a/docs/examples/promise/06_make_transfer/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Make a simple transfer | polkadot-js/api - - - - - - - -
polkadot-js/api

Make a simple transfer

This sample shows how to create a transaction to make a transfer from one an account to another.

// @ts-check
-// Import the API, Keyring and some utility functions
-const { ApiPromise } = require('@polkadot/api');
-const { Keyring } = require('@polkadot/keyring');
-const { stringToU8a } = require('@polkadot/util');
-
-// Important to note that we pad the seed to a length of 32 bytes using ' '
-// The underlying seed needs to be exactly 32 bytes in length
-const ALICE_SEED = 'Alice'.padEnd(32, ' ');
-const BOB_ADDR = '5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE';
-
-async function main () {
-  // Create an instance of the keyring
-  const keyring = new Keyring();
-
-  // Add Alice to our keyring (with the known seed for the account)
-  const alice = keyring.addFromSeed(stringToU8a(ALICE_SEED));
-
-  // Instantiate the API
-  const api = await ApiPromise.create();
-
-  // Create a extrinsic, transferring 12345 units to Bob
-  const transfer = api.tx.balances.transfer(BOB_ADDR, 12345);
-
-  // Sign and send the transaction using our account
-  const hash = await transfer.signAndSend(alice);
-
-  console.log('Transfer sent with hash', hash.toHex());
-}
-
-main().catch(console.error).finally(() => process.exit());
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

- ← - - Display system events - - → -

- - - diff --git a/docs/examples/promise/08_system_events/index.html b/docs/examples/promise/08_system_events/index.html deleted file mode 100644 index cbdef1f594..0000000000 --- a/docs/examples/promise/08_system_events/index.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Traverse events | polkadot-js/api - - - - - - - -
polkadot-js/api

Traverse events

Query the system events and extract information from them. This example runs until exited via Ctrl-C

// @ts-check
-// Import the API
-const { ApiPromise } = require('@polkadot/api');
-
-async function main () {
-  // Create our API with a default connection to the local node
-  const api = await ApiPromise.create();
-
-  // subscribe to system events via storage
-  api.query.system.events((events) => {
-    console.log(`\nReceived ${events.length} events:`);
-
-    // loop through the Vec<EventRecord>
-    events.forEach((record) => {
-      // extract the phase, event and the event types
-      const { event, phase } = record;
-      const types = event.typeDef;
-
-      // show what we are busy with
-      console.log(`\t${event.section}:${event.method}:: (phase=${phase.toString()})`);
-      console.log(`\t\t${event.meta.documentation.toString()}`);
-
-      // loop through each of the parameters, displaying the type and data
-      event.data.forEach((data, index) => {
-        console.log(`\t\t\t${types[index].type}: ${data.toString()}`);
-      });
-    });
-  });
-}
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(-1);
-});
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

- ← - - Transaction with events - - → -

- - - diff --git a/docs/examples/promise/09_transfer_events/index.html b/docs/examples/promise/09_transfer_events/index.html deleted file mode 100644 index 5a843a823b..0000000000 --- a/docs/examples/promise/09_transfer_events/index.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Transfer events | polkadot-js/api - - - - - - - -
polkadot-js/api

Transfer events

Display the events that occur during a transfer by sending a value to a random account

// @ts-check
-// Import the API & Provider and some utility functions
-const { ApiPromise } = require('@polkadot/api');
-
-// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
-const testKeyring = require('@polkadot/keyring/testing');
-
-// utility function for random values
-const { randomAsU8a } = require('@polkadot/util-crypto');
-
-// some constants we are using in this sample
-const ALICE = '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ';
-const AMOUNT = 10000;
-
-async function main () {
-  // create an instance of our testign keyring
-  // If you're using ES6 module imports instead of require, just change this line to:
-  // const keyring = testKeyring();
-  const keyring = testKeyring.default();
-
-  // Create the API and wait until ready
-  const api = await ApiPromise.create();
-
-  // get the nonce for the admin key
-  const nonce = await api.query.system.accountNonce(ALICE);
-
-  // find the actual keypair in the keyring
-  const alicePair = keyring.getPair(ALICE);
-
-  // create a new random recipient
-  const recipient = keyring.addFromSeed(randomAsU8a(32)).address();
-
-  console.log('Sending', AMOUNT, 'from', alicePair.address(), 'to', recipient, 'with nonce', nonce.toString());
-
-  // Do the transfer and track the actual status
-  api.tx.balances
-    .transfer(recipient, AMOUNT)
-    .sign(alicePair, { nonce })
-    .send(({ events = [], status, type }) => {
-      console.log('Transaction status:', type);
-
-      if (type === 'Finalised') {
-        console.log('Completed at block hash', status.asFinalised.toHex());
-        console.log('Events:');
-
-        events.forEach(({ phase, event: { data, method, section } }) => {
-          console.log('\t', phase.toString(), `: ${section}.${method}`, data.toString());
-        });
-
-        process.exit(0);
-      }
-    });
-}
-
-main().catch(console.error);
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

- ← - - Upgrade via sudo - - → -

- - - diff --git a/docs/examples/promise/10_upgrade_chain/index.html b/docs/examples/promise/10_upgrade_chain/index.html deleted file mode 100644 index 5a9d9bc946..0000000000 --- a/docs/examples/promise/10_upgrade_chain/index.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - Chain upgrade | polkadot-js/api - - - - - - - -
polkadot-js/api

Chain upgrade

Performs a chain upgrade using the sudo module. This may brick your chain, so us it as an educational sample. (use substrate --dev purge-chain to remove DB and recover).

// @ts-check
-// Import the API & Provider and some utility functions
-const { ApiPromise, WsProvider } = require('@polkadot/api');
-
-// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
-const testKeyring = require('@polkadot/keyring/testing');
-
-const fs = require('fs');
-
-async function main () {
-  // Initialise the provider to connect to the local node
-  const provider = new WsProvider('ws://127.0.0.1:9944');
-
-  // Create the API and wait until ready (optional provider passed through)
-  const api = await ApiPromise.create(provider);
-
-  // retrieve the upgrade key from the chain state
-  const adminId = await api.query.sudo.key();
-
-  // find the actual keypair in the keyring (if this is an changed value, the key
-  // needs to be added to the keyring before - this assumes we have defaults, i.e.
-  // Alice as the key - and this already exists on the test keyring)
-  const keyring = testKeyring.default();
-  const adminPair = keyring.getPair(adminId.toString());
-
-  // retrieve the runtime to upgrade to
-  const code = fs.readFileSync('./test.wasm').toString('hex');
-  const proposal = api.tx.consensus.setCode(`0x${code}`);
-
-  console.log(`Upgrading from ${adminId}, ${code.length / 2} bytes`);
-
-  // preform the actual chain upgrade via the sudo module
-  api.tx.sudo
-    .sudo(proposal)
-    .signAndSend(adminPair, ({ events = [], status, type }) => {
-      console.log('Proposal status:', type);
-
-      if (type === 'Finalised') {
-        console.error('You have just upgraded your chain');
-
-        console.log('Completed at block hash', status.asFinalised.toHex());
-        console.log('Events:');
-
-        events.forEach(({ phase, event: { data, method, section } }) => {
-          console.log('\t', phase.toString(), `: ${section}.${method}`, data.toString());
-        });
-
-        process.exit(0);
-      }
-    });
-}
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(-1);
-});
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

- ← - - Substrate RPC - - → -

- - - diff --git a/docs/examples/promise/index.html b/docs/examples/promise/index.html deleted file mode 100644 index 74a07552e7..0000000000 --- a/docs/examples/promise/index.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - ApiPromise Examples | polkadot-js/api - - - - - - - -
polkadot-js/api

ApiPromise Examples

Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain. It uses the [[ApiPromise]] interface.

Prerequisites

For the following examples, you need a local node. It is usually convenient testing with:

substrate --dev
-
1

Running the examples

From each folder, run yarn to install the required dependencies and then run yarn start to execute the example against the running node.

Development accounts

Some of the examples use the following accounts:

  • Alice: 5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ
  • Bob: 5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE

Those accounts are easy to add if you don't have/see them. The seed of Alice's account is Alice␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣ and the seed of Bob is... well you guess...

NOTE: Note the spaces padding Alice's key up to 32 chars.

- - - diff --git a/docs/examples/rx/01_simple_connect/index.html b/docs/examples/rx/01_simple_connect/index.html deleted file mode 100644 index 61ae557164..0000000000 --- a/docs/examples/rx/01_simple_connect/index.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - Simple Connect | polkadot-js/api - - - - - - - -
polkadot-js/api

Simple Connect

The following example shows how to instantiate a Polkadot API object and use it to connect to a node using ApiRx.

// Required imports
-const { zip } = require('rxjs');
-const { ApiRx } = require('@polkadot/api');
-const { WsProvider } = require('@polkadot/rpc-provider');
-
-function main () {
-  // Initialise the provider to connect to the local node
-  const provider = new WsProvider('ws://127.0.0.1:9944');
-
-  // Create the API and wait until ready
-  const api = await ApiRx.create(provider).toPromise();
-
-  // We're using RxJs 'zip()' combination operator to get the emitted values
-  // of multiple observables as an array
-  zip(
-    api.rpc.system.chain(),
-    api.rpc.system.name(),
-    api.rpc.system.version()
-  )
-  // Then we subscribe to the result
-  .subscribe(([chain, nodeName, nodeVersion]) => {
-    console.log(`You are connected to chain ${chain} using ${nodeName} v${nodeVersion}`);
-  });
-}
-
-main().catch(console.error).finally(() => process.exit());
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
- - - diff --git a/docs/examples/rx/02_listen_to_blocks/index.html b/docs/examples/rx/02_listen_to_blocks/index.html deleted file mode 100644 index 3d26baf976..0000000000 --- a/docs/examples/rx/02_listen_to_blocks/index.html +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - Listen to new blocks | polkadot-js/api - - - - - - - -
polkadot-js/api

Listen to new blocks

This example shows how to subscribe to new blocks.

It displays the block number every time a new block is seen by the node you are connected to.

NOTE: The example runs until you stop it with CTRL+C

// Import the API
-const { ApiRx } = require('@polkadot/api');
-const { switchMap } = require('rxjs/operators');
-
-async function main () {
-  // Here we don't pass the (optional) provider, connecting directly to the default
-  // node/port, i.e. `ws://127.0.0.1:9944`. Await for the isReady promise to ensure
-  // the API has connected to the node and completed the initialisation process
-  new ApiRx().isReady
-    .pipe(
-      switchMap((api) =>
-        api.rpc.chain.subscribeNewHead()
-      ))
-    .subscribe((header) => {
-      console.log(`Chain is at block: #${header.blockNumber}`);
-    });
-}
-
-main().catch(console.error);
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
- - - diff --git a/docs/examples/rx/03_listen_to_balance_change/index.html b/docs/examples/rx/03_listen_to_balance_change/index.html deleted file mode 100644 index 14bd6e9aee..0000000000 --- a/docs/examples/rx/03_listen_to_balance_change/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Listen to balance changes | polkadot-js/api - - - - - - - - - - - diff --git a/docs/examples/rx/04_unsubscribe/index.html b/docs/examples/rx/04_unsubscribe/index.html deleted file mode 100644 index bf5838a928..0000000000 --- a/docs/examples/rx/04_unsubscribe/index.html +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - Unsubscribe from listening to updates | polkadot-js/api - - - - - - - -
polkadot-js/api

Unsubscribe from listening to updates

This example shows how to subscribe to and later unsubscribe from listening to block updates.

In this example we're calling the built-in unsubscribe() function after a timeOut of 20s to cleanup and unsubscribe from listening to updates.

// Import the API
-const { ApiRx } = require('@polkadot/api');
-const { switchMap } = require('rxjs/operators');
-
-async function main () {
-  // Create a new instance of the api
-  // Subscribe to chain updates and log the current block  number on update.
-  const subscription = new ApiRx().isReady
-    .pipe(
-      switchMap((api) =>
-        api.rpc.chain.subscribeNewHead()
-      ))
-    .subscribe((header) => {
-      console.log(`Chain is at block: #${header.blockNumber}`);
-    });
-
-  // In this example we're calling the Overvables unsubscribe() //
-  // function after 20s.
-  setTimeout(() => {
-    subscription.unsubscribe();
-    console.log('Unsubscribed');
-  }, 20000);
-}
-
-main().catch(console.error);
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
- - - diff --git a/docs/examples/rx/05_read_storage/index.html b/docs/examples/rx/05_read_storage/index.html deleted file mode 100644 index 993fd4b6e6..0000000000 --- a/docs/examples/rx/05_read_storage/index.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Read storage | polkadot-js/api - - - - - - - -
polkadot-js/api

Read storage

Many important variables are available through the storage API. This example shows how to call a few of those APIs.

// Import the API
-const { ApiRx } = require('@polkadot/api');
-// Import dependencies from RxJs
-const { combineLatest, of } = require('rxjs');
-const { first, switchMap } = require('rxjs/operators');
-
-// Our address for Alice on the dev chain
-const Alice = '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ';
-
-function main () {
-  // Create our API with a default connection to the local node
-  new ApiRx(provider).isReady
-    .pipe(
-      // Here we ake our basic chain state/storage queries
-      switchMap((api) => combineLatest(
-        of(api),
-        api.query.session.validators().pipe(first())
-      )),
-      switchMap(([api, validators]) => {
-        // In the next step, we're checking if the node has active validators.
-        // If it does, we're making another call to the api to get the balances for all validators
-        const balances = (validators && validators.length > 0)
-          ? combineLatest(validators.map(authorityId => api.query.balances.freeBalance(authorityId).pipe(first())))
-          : of(null);
-
-        // We're combining the results together with the emitted value 'validators',
-        // which we're turning back into an observable using of()
-        return combineLatest(
-          api.query.system.accountNonce(Alice).pipe(first()),
-          api.query.timestamp.blockPeriod().pipe(first()),
-          of(validators),
-          balances
-        );
-      })
-    )
-    // Then we're subscribing to the emitted results
-    .subscribe(([accountNonce, blockPeriod, validators, validatorBalances]) => {
-      console.log(`accountNonce(${Alice}) ${accountNonce}`);
-      console.log(`blockPeriod ${blockPeriod.toNumber()} seconds`);
-
-      if (validatorBalances) {
-        // And lastly we print out the authorityIds and balances of all validators
-        console.log('validators', validators.map((authorityId, index) => ({
-          address: authorityId.toString(),
-          balance: validatorBalances[index].toString()
-        })));
-      }
-    });
-}
-
-main().catch(console.error).finally(_ => process.exit());
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
- - - diff --git a/docs/examples/rx/06_make_transfer/index.html b/docs/examples/rx/06_make_transfer/index.html deleted file mode 100644 index e01b6a42a7..0000000000 --- a/docs/examples/rx/06_make_transfer/index.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - Make a simple transfer | polkadot-js/api - - - - - - - -
polkadot-js/api

Make a simple transfer

This sample shows how to create a transaction to make a transfer from one an account to another.

// Import the API, Keyring and some utility functions
-const { ApiPromise } = require('@polkadot/api');
-const { Keyring } = require('@polkadot/keyring');
-const { stringToU8a } = require('@polkadot/util');
-
-const ALICE_SEED = 'Alice'.padEnd(32, ' ');
-const BOB_ADDR = '5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE';
-
-async function main () {
-  // Create an instance of the keyring
-  const keyring = new Keyring();
-
-  // Add Alice to our keyring (with the known seed for the account)
-  const alice = keyring.addFromSeed(stringToU8a(ALICE_SEED));
-
-  // Instantiate the API
-  const api = await ApiRx.create().toPromise();
-
-  //  Create a extrinsic, transferring 12345 units to Bob.
-  api.tx.balances
-    // create transfer
-    .transfer(BOB, randomAmount)
-    // Sign and send the transcation
-    .signAndSend(alice)
-    // Subscribe to the status updates of the transfer
-    .subscribe(({ status, type }) => {
-      if (type === 'Finalised') {
-        console.log(`Successful transfer of 12345 from Alice to Bob with hash ${status.asFinalised.toHex()}`);
-      } else {
-        console.log(`Staus of transfer: ${type}`);
-      }
-    });
-}
-
-main().catch(console.error).finally(_ => process.exit());
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
- - - diff --git a/docs/examples/rx/08_system_events/index.html b/docs/examples/rx/08_system_events/index.html deleted file mode 100644 index 1598019c8e..0000000000 --- a/docs/examples/rx/08_system_events/index.html +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - Traverse events | polkadot-js/api - - - - - - - -
polkadot-js/api

Traverse events

Query the system events and extract information from them. This example runs until exited via Ctrl-C

// Import the API and selected RxJs operators
-const { switchMap } = require('rxjs/operators');
-const { ApiRx } = require('@polkadot/api');
-
-async function main () {
-  // Create our API with a default connection to the local node
-  ApiRx.create()
-    .pipe(
-      switchMap((api) =>
-        // subscribe to system events via storage
-        api.query.system.events()
-      ))
-      // Then we're subscribing to the emitted results
-    .subscribe((events) => {
-      console.log(`\nReceived ${events.length} events:`);
-      // loop through the Vec<EventRecord>
-      events.forEach((record) => {
-      // extract the phase, event and the event types
-        const { event, phase } = record;
-        const types = event.typeDef;
-
-        // show what we are busy with
-        console.log(`\t${event.section}:${event.method}:: (phase=${phase.toString()})`);
-        console.log(`\t\t${event.meta.documentation.toString()}`);
-
-        // loop through each of the parameters, displaying the type and data
-        event.data.forEach((data, index) => {
-          console.log(`\t\t\t${types[index].type}: ${data.toString()}`);
-        });
-      });
-    });
-};
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(-1);
-});
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
- - - diff --git a/docs/examples/rx/09_transfer_events/index.html b/docs/examples/rx/09_transfer_events/index.html deleted file mode 100644 index 8dadbe82e8..0000000000 --- a/docs/examples/rx/09_transfer_events/index.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - Transfer events | polkadot-js/api - - - - - - - -
polkadot-js/api

Transfer events

Display the events that occur during a transfer by sending a value to a random account

// Import the API and some utility functions
-const { ApiRx } = require('@polkadot/api');
-
-// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
-const testKeyring = require('@polkadot/keyring/testing');
-
-// utility function for random values
-const { randomAsU8a } = require('@polkadot/util-crypto');
-
-// some constants we are using in this sample
-const ALICE = '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ';
-const AMOUNT = 10000;
-
-async function main () {
-  // create an instance of our testign keyring
-  // If you're using ES6 module imports instead of require, just change this line to:
-  // const keyring = testKeyring();
-  const keyring = testKeyring.default();
-
-  // Create our API with a connection to the node
-  const api = await ApiRx.create().toPromise();
-
-  // find the actual keypair in the keyring
-  const alicePair = keyring.getPair(ALICE);
-
-  // create a new random recipient
-  const recipient = keyring.addFromSeed(randomAsU8a(32)).address();
-
-  console.log('Sending', AMOUNT, 'from', alicePair.address(), 'to', recipient);
-
-  // get the nonce for the admin key
-  //  Create a extrinsic, transferring 12345 units to Bob.
-  api.tx.balances
-    // Do the transfer
-    .transfer(recipient, AMOUNT)
-    // Sign and send it
-    .signAndSend(alicePair)
-    // And subscribe to the actual status
-    .subscribe(({ events = [], status, type }) => {
-      // Log transfer events
-      console.log('Transfer status:', type);
-      // Log system events once the transfer is finalised
-      if (type === 'Finalised') {
-        console.log('Completed at block hash', status.asFinalised.toHex());
-        console.log('Events:');
-
-        events.forEach(({ phase, event: { data, method, section } }) => {
-          console.log('\t', phase.toString(), `: ${section}.${method}`, data.toString());
-        });
-      }
-    });
-}
-
-main().catch(console.error);
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
- - - diff --git a/docs/examples/rx/10_upgrade_chain/index.html b/docs/examples/rx/10_upgrade_chain/index.html deleted file mode 100644 index 8626d956ca..0000000000 --- a/docs/examples/rx/10_upgrade_chain/index.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - Chain upgrade | polkadot-js/api - - - - - - - -
polkadot-js/api

Chain upgrade

Performs a chain upgrade using the sudo module. This may brick your chain, so us it as an educational sample. (use substrate --dev purge-chain to remove DB and recover).

// Import the API & Provider and some utility functions
-const { ApiRx } = require('@polkadot/api');
-const { WsProvider } = require('@polkadot/rpc-provider');
-// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
-const testKeyring = require('@polkadot/keyring/testing');
-const fs = require('fs');
-
-async function main () {
-  // Initialise the provider to connect to the local node
-  const provider = new WsProvider('ws://127.0.0.1:9944');
-
-  // Create the API and wait until ready (optional provider passed through)
-  const api = await ApiRx.create(provider).toPromise();
-
-  // retrieve the upgrade key from the chain state
-  const adminId = await api.query.sudo.key().toPromise();
-
-  // find the actual keypair in the keyring (if this is an changed value, the key
-  // needs to be added to the keyring before - this assumes we have defaults, i.e.
-  // Alice as the key - and this already exists on the test keyring)
-  const keyring = testKeyring.default();
-  const adminPair = keyring.getPair(adminId.toString());
-
-  // retrieve the runtime to upgrade to
-  const code = fs.readFileSync('./test.wasm').toString('hex');
-  const proposal = api.tx.consensus.setCode(`0x${code}`);
-
-  console.log(`Upgrading chain runtime from ${adminId}`);
-
-  api.tx.sudo
-    // preform the actual chain upgrade via the sudo module
-    .sudo(proposal)
-    // sign and send the proposal
-    .signAndSend(adminPair)
-    // subscribe to overall result
-    .subscribe(({ events = [], status, type }) => {
-      // Log transfer events
-      console.log('Proposal status:', type);
-
-      if (type === 'Finalised') {
-        console.error('You have just upgraded your chain');
-
-        console.log('Completed at block hash', status.asFinalised.toHex());
-        console.log('Events:');
-
-        // Log system events once the chain update is finalised
-        events.forEach(({ phase, event: { data, method, section } }) => {
-          console.log('\t', phase.toString(), `: ${section}.${method}`, data.toString());
-        });
-
-        process.exit(0);
-      }
-    });
-}
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(-1);
-});
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
- - - diff --git a/docs/examples/rx/index.html b/docs/examples/rx/index.html deleted file mode 100644 index 5103b4da12..0000000000 --- a/docs/examples/rx/index.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - ApiRx Examples | polkadot-js/api - - - - - - - -
polkadot-js/api

ApiRx Examples

Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain. It uses the [[ApiRx]] interface.

Prerequisites

For the following examples, you need a local node. It is usually convenient testing with:

substrate --dev
-
1

Running the examples

From each folder, run yarn to install the required dependencies and then run yarn start to execute the example against the running node.

Development accounts

Some of the examples use the following accounts:

  • Alice: 5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ
  • Bob: 5Gw3s7q4QLkSWwknsiPtjujPv3XM4Trxi5d4PgKMMk3gfGTE

Those accounts are easy to add if you don't have/see them. The seed of Alice's account is Alice␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣␣ and the seed of Bob is... well you guess...

NOTE: Note the spaces padding Alice's key up to 32 chars.

- - - diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index cf6bbdb9d7..0000000000 --- a/docs/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Polkadot Javascript API | polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-core/README.md b/docs/rpc-core/README.md deleted file mode 100644 index e16468e6f5..0000000000 --- a/docs/rpc-core/README.md +++ /dev/null @@ -1,76 +0,0 @@ - -@polkadot/rpc-core -================== - -This library provides a clean wrapper around all the methods exposed by a Polkadot network client. - -Usage ------ - -Installation - - -``` -yarn add @polkadot/rpc-core -``` - -Initialisation - - -```js -import Rpc from '@polkadot/rpc-core'; -import WsProvider from '@polkadot/rpc-provider/ws'; - -const provider = new WsProvider('http://127.0.0.1:9944'); -const api = new Rpc(provider); -``` - -Retrieving the block header object for a given block header hash (a 0x-prefixed hex string with length of 64) - - -```js -api.chain - .getHeader('0x1234567890') - .then((header) => console.log(header)) - .catch((error) => console.error(error)); -``` - -Retrieving the best block number, parent hash, state root hash, extrinsics root hash, and digest (once-off) - - -```js -api.chain - .getHead() - .then((headerHash) => { - return api.chain.getHeader(headerHash); - }) - .then((header) => { - console.log(`best #${header.blockNumber.toString()}`); - console.log(`parentHash: ${header.parentHash.toString()}`); - console.log(`stateRoot: ${header.stateRoot.toString()}`); - console.log(`extrinsicsRoot: ${header.extrinsicsRoot.toString()}`); - console.log(`digest: ${header.digest.toString()}`); - }) - .catch((error) => { - console.error('error:', error); - }); -``` - -Retrieving best header via subscription - - -```js -api.chain - .subscribeNewHead((header) => { - console.log(`best #${header.blockNumber}`); - }) - .then((subscriptionId) => { - console.log(`subscriptionId: ${subscriptionId}`); - // id for the subscription, can unsubscribe via - // api.chain.subscribeNewHead.unsubscribe(subscriptionId); - }) - .catch((error) => { - console.error('error subscribing:', error); - }); -``` - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/rpc-core/SUMMARY.html b/docs/rpc-core/SUMMARY.html deleted file mode 100644 index a163ef12d7..0000000000 --- a/docs/rpc-core/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-core/SUMMARY.md b/docs/rpc-core/SUMMARY.md deleted file mode 100644 index 33c4b285d2..0000000000 --- a/docs/rpc-core/SUMMARY.md +++ /dev/null @@ -1,3 +0,0 @@ -* ["types"](modules/_types_.md) - * [RpcInterface](interfaces/_types_.rpcinterface.md) - * [RpcInterface$Method](interfaces/_types_.rpcinterface_method.md) diff --git a/docs/rpc-core/index.html b/docs/rpc-core/index.html deleted file mode 100644 index d4be90849a..0000000000 --- a/docs/rpc-core/index.html +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/rpc-core

This library provides a clean wrapper around all the methods exposed by a Polkadot network client.

Usage

Installation -

yarn add @polkadot/rpc-core
-
1

Initialisation -

import Rpc from '@polkadot/rpc-core';
-import WsProvider from '@polkadot/rpc-provider/ws';
-
-const provider = new WsProvider('http://127.0.0.1:9944');
-const api = new Rpc(provider);
-
1
2
3
4
5

Retrieving the block header object for a given block header hash (a 0x-prefixed hex string with length of 64) -

api.chain
-  .getHeader('0x1234567890')
-  .then((header) => console.log(header))
-  .catch((error) => console.error(error));
-
1
2
3
4

Retrieving the best block number, parent hash, state root hash, extrinsics root hash, and digest (once-off) -

api.chain
-  .getHead()
-  .then((headerHash) => {
-    return api.chain.getHeader(headerHash);
-  })
-  .then((header) => {
-    console.log(`best #${header.blockNumber.toString()}`);
-    console.log(`parentHash: ${header.parentHash.toString()}`);
-    console.log(`stateRoot: ${header.stateRoot.toString()}`);
-    console.log(`extrinsicsRoot: ${header.extrinsicsRoot.toString()}`);
-    console.log(`digest: ${header.digest.toString()}`);
-  })
-  .catch((error) => {
-    console.error('error:', error);
-  });
-
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

Retrieving best header via subscription -

api.chain
-  .subscribeNewHead((header) => {
-    console.log(`best #${header.blockNumber}`);
-  })
-  .then((subscriptionId) => {
-    console.log(`subscriptionId: ${subscriptionId}`);
-    // id for the subscription, can unsubscribe via
-    // api.chain.subscribeNewHead.unsubscribe(subscriptionId);
-  })
-  .catch((error) => {
-    console.error('error subscribing:', error);
-  });
-
1
2
3
4
5
6
7
8
9
10
11
12

Classes

Classes

- - - diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface.html b/docs/rpc-core/interfaces/_types_.rpcinterface.html deleted file mode 100644 index da324ba2ab..0000000000 --- a/docs/rpc-core/interfaces/_types_.rpcinterface.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface.md b/docs/rpc-core/interfaces/_types_.rpcinterface.md deleted file mode 100644 index 81037bdd42..0000000000 --- a/docs/rpc-core/interfaces/_types_.rpcinterface.md +++ /dev/null @@ -1,45 +0,0 @@ - - -# Hierarchy - -**RpcInterface** - -# Properties - - - -## author - -**● author**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* - -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L17)* - -___ - - -## chain - -**● chain**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* - -*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L18)* - -___ - - -## state - -**● state**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* - -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L19)* - -___ - - -## system - -**● system**: *[RpcInterface$Section](../modules/_types_.md#rpcinterface_section)* - -*Defined in [types.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L20)* - -___ - diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface_method.html b/docs/rpc-core/interfaces/_types_.rpcinterface_method.html deleted file mode 100644 index 2f45ee3a31..0000000000 --- a/docs/rpc-core/interfaces/_types_.rpcinterface_method.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md b/docs/rpc-core/interfaces/_types_.rpcinterface_method.md deleted file mode 100644 index 72655d2f5a..0000000000 --- a/docs/rpc-core/interfaces/_types_.rpcinterface_method.md +++ /dev/null @@ -1,51 +0,0 @@ - - -# Hierarchy - -**RpcInterface$Method** - -# Callable -▸ **__call**(...params: *`Array`<`any`>*): `Promise`<`any`> - -*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L5)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -# Properties - - - -## subscription - -**● subscription**: *`string`* - -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L8)* - -___ - - -## unsubscribe - -**● unsubscribe**: *`function`* - -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L9)* - -#### Type declaration -▸(id: *`number`*): `Promise`<`any`> - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| id | `number` | - -**Returns:** `Promise`<`any`> - -___ - diff --git a/docs/rpc-core/modules/_types_.html b/docs/rpc-core/modules/_types_.html deleted file mode 100644 index 5fe277bf7f..0000000000 --- a/docs/rpc-core/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-core/modules/_types_.md b/docs/rpc-core/modules/_types_.md deleted file mode 100644 index 12044fb41e..0000000000 --- a/docs/rpc-core/modules/_types_.md +++ /dev/null @@ -1,31 +0,0 @@ - - -# Index - -### Interfaces - -* [RpcInterface](../interfaces/_types_.rpcinterface.md) -* [RpcInterface$Method](../interfaces/_types_.rpcinterface_method.md) - -### Type aliases - -* [RpcInterface$Section](_types_.md#rpcinterface_section) - ---- - -# Type aliases - - - -## RpcInterface$Section - -**Ƭ RpcInterface$Section**: *`object`* - -*Defined in [types.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-core/src/types.ts#L12)* - -#### Type declaration - -[index: `string`]: [RpcInterface$Method](../interfaces/_types_.rpcinterface_method.md) - -___ - diff --git a/docs/rpc-provider/README.md b/docs/rpc-provider/README.md deleted file mode 100644 index 769f684c70..0000000000 --- a/docs/rpc-provider/README.md +++ /dev/null @@ -1,51 +0,0 @@ - -@polkadot/rpc-provider -====================== - -Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface. - -Provider Selection ------------------- - -There are two flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets. It is generally recommended to use the [WsProvider](classes/_ws_provider_.wsprovider.md) since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client. - -Both providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection. - -Usage ------ - -Installation - - -``` -yarn add @polkadot/rpc-provider -``` - -WebSocket Initialisation - - -```javascript -import WsProvider from '@polkadot/rpc-provider/ws'; - -// this is the actual default endpoint -const provider = new WsProvider('ws://127.0.0.1:9944'); -const version = await provider.send('client_version', []); - -console.log('client version', version); -``` - -HTTP Initialisation - - -```javascript -import { HttpProvider } from '@polkadot/rpc-provider'; - -// this is the actual default endpoint -const provider = new HttpProvider('http://127.0.0.1:9933'); -const version = await provider.send('chain_getBlockHash', []); - -console.log('latest block Hash', hash); -``` - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/rpc-provider/SUMMARY.html b/docs/rpc-provider/SUMMARY.html deleted file mode 100644 index 1e532ceb2d..0000000000 --- a/docs/rpc-provider/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-provider/SUMMARY.md b/docs/rpc-provider/SUMMARY.md deleted file mode 100644 index f7cf68abcf..0000000000 --- a/docs/rpc-provider/SUMMARY.md +++ /dev/null @@ -1,9 +0,0 @@ -* ["defaults"](modules/_defaults_.md) -* ["http/polyfill"](modules/_http_polyfill_.md) -* ["http/types"](modules/_http_types_.md) -* ["mock/types"](modules/_mock_types_.md) -* ["types"](modules/_types_.md) - * [ProviderInterface](interfaces/_types_.providerinterface.md) -* ["ws/Provider"](modules/_ws_provider_.md) - * [WsProvider](classes/_ws_provider_.wsprovider.md) -* ["ws/polyfill"](modules/_ws_polyfill_.md) diff --git a/docs/rpc-provider/classes/_ws_provider_.wsprovider.html b/docs/rpc-provider/classes/_ws_provider_.wsprovider.html deleted file mode 100644 index 412e550a88..0000000000 --- a/docs/rpc-provider/classes/_ws_provider_.wsprovider.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/rpc-provider/ws

name: WsProvider

description: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. Unlike the [[HttpProvider]], it does support subscriptions and allows listening to events such as new blocks or balance changes.

example:

import Api from '@polkadot/api/promise';
-import WsProvider from '@polkadot/rpc-provider/ws';
-
-const provider = new WsProvider('ws://127.0.0.1:9944');
-const api = new Api(provider);
-
1
2
3
4
5

see: [[HttpProvider]]

Hierarchy

WsProvider

Implements

  • WSProviderInterface

Constructors

constructor

⊕ new WsProvider(endpoint?: string, autoConnect?: boolean): WsProvider

Defined in ws/Provider.ts:75

Parameters:

Name Type Default value Description
Default value endpoint string defaults.WS_URL The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`
Default value autoConnect boolean true Whether to connect automatically or not.

Returns: WsProvider

Accessors

hasSubscriptions

get hasSubscriptions(): boolean

Defined in ws/Provider.ts:101

summary: true when this provider supports subscriptions

Returns: boolean

Methods

clone

▸ clone(): WsProvider

Defined in ws/Provider.ts:108

description: Returns a clone of the object

Returns: WsProvider

connect

▸ connect(): void

Defined in ws/Provider.ts:117

summary: Manually connect

description: The WsProvider connects automatically by default, however if you decided otherwise, you may connect manually using this method.

Returns: void

disconnect

▸ disconnect(): void

Defined in ws/Provider.ts:133

description: Manually disconnect from the connection, clearing autoconnect logic

Returns: void

isConnected

▸ isConnected(): boolean

Defined in ws/Provider.ts:150

summary: Whether the node is connected or not.

Returns: boolean -true if connected

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void

Defined in ws/Provider.ts:159

summary: Listens on events after having subscribed using the subscribe function.

Parameters:

Name Type Description
type ProviderInterface$Emitted Event
sub ProviderInterface$EmitCb Callback

Returns: void

send

▸ send(method: string, params: Array<any>, subscription?: SubscriptionHandler): Promise<any>

Defined in ws/Provider.ts:169

summary: Send JSON data using WebSockets to configured HTTP Endpoint or queue.

Parameters:

Name Type Description
method string The RPC methods to execute
params Array<any> Encoded paramaters as appliucable for the method
Optional subscription SubscriptionHandler Subscription details (internally used)

Returns: Promise<any>

subscribe

▸ subscribe(type: string, method: string, params: Array<any>, callback: ProviderInterface$Callback): Promise<number>

Defined in ws/Provider.ts:223

name: subscribe

summary: Allows subscribing to a specific event.

example:

const provider = new WsProvider('ws://127.0.0.1:9944');
-const rpc = new Rpc(provider);
-
-rpc.state.subscribeStorage([[storage.balances.freeBalance, <Address>]], (_, values) => {
-  console.log(values)
-}).then((subscriptionId) => {
-  console.log('balance changes subscription id: ', subscriptionId)
-})
-
1
2
3
4
5
6
7
8

Parameters:

Name Type Description
type string Subscription type
method string Subscription method
params Array<any> Parameters
callback ProviderInterface$Callback Callback

Returns: Promise<number> -Promise resolving to the dd of the subscription you can use with [[unsubscribe]].

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

Defined in ws/Provider.ts:232

summary: Allows unsubscribing to subscriptions made with subscribe.

Parameters:

Name Type
type string
method string
id number

Returns: Promise<boolean>

- - - diff --git a/docs/rpc-provider/classes/_ws_provider_.wsprovider.md b/docs/rpc-provider/classes/_ws_provider_.wsprovider.md deleted file mode 100644 index 38fa495ac9..0000000000 --- a/docs/rpc-provider/classes/_ws_provider_.wsprovider.md +++ /dev/null @@ -1,224 +0,0 @@ - - -@polkadot/rpc-provider/ws -========================= - -*__name__*: WsProvider - -*__description__*: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. Unlike the \[\[HttpProvider\]\], it does support subscriptions and allows listening to events such as new blocks or balance changes. - -*__example__*: - -```javascript -import Api from '@polkadot/api/promise'; -import WsProvider from '@polkadot/rpc-provider/ws'; - -const provider = new WsProvider('ws://127.0.0.1:9944'); -const api = new Api(provider); -``` - -*__see__*: \[\[HttpProvider\]\] - -# Hierarchy - -**WsProvider** - -# Implements - -* `WSProviderInterface` - -# Constructors - - - -## constructor - -⊕ **new WsProvider**(endpoint?: *`string`*, autoConnect?: *`boolean`*): [WsProvider](_ws_provider_.wsprovider.md) - -*Defined in [ws/Provider.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L75)* - -**Parameters:** - -| Name | Type | Default value | Description | -| ------ | ------ | ------ | ------ | -| `Default value` endpoint | `string` | defaults.WS_URL | The endpoint url. Usually \`ws://ip:9944\` or \`wss://ip:9944\` | -| `Default value` autoConnect | `boolean` | true | Whether to connect automatically or not. | - -**Returns:** [WsProvider](_ws_provider_.wsprovider.md) - -___ - -# Accessors - - - -## hasSubscriptions - -**get hasSubscriptions**(): `boolean` - -*Defined in [ws/Provider.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L101)* - -*__summary__*: `true` when this provider supports subscriptions - -**Returns:** `boolean` - -___ - -# Methods - - - -## clone - -▸ **clone**(): [WsProvider](_ws_provider_.wsprovider.md) - -*Defined in [ws/Provider.ts:108](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L108)* - -*__description__*: Returns a clone of the object - -**Returns:** [WsProvider](_ws_provider_.wsprovider.md) - -___ - - -## connect - -▸ **connect**(): `void` - -*Defined in [ws/Provider.ts:117](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L117)* - -*__summary__*: Manually connect - -*__description__*: The [WsProvider](_ws_provider_.wsprovider.md) connects automatically by default, however if you decided otherwise, you may connect manually using this method. - -**Returns:** `void` - -___ - - -## disconnect - -▸ **disconnect**(): `void` - -*Defined in [ws/Provider.ts:133](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L133)* - -*__description__*: Manually disconnect from the connection, clearing autoconnect logic - -**Returns:** `void` - -___ - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Defined in [ws/Provider.ts:150](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L150)* - -*__summary__*: Whether the node is connected or not. - -**Returns:** `boolean` -true if connected - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` - -*Defined in [ws/Provider.ts:159](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L159)* - -*__summary__*: Listens on events after having subscribed using the [subscribe](_ws_provider_.wsprovider.md#subscribe) function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted) | Event | -| sub | [ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb) | Callback | - -**Returns:** `void` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*, subscription?: *`SubscriptionHandler`*): `Promise`<`any`> - -*Defined in [ws/Provider.ts:169](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L169)* - -*__summary__*: Send JSON data using WebSockets to configured HTTP Endpoint or queue. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| method | `string` | The RPC methods to execute | -| params | `Array`<`any`> | Encoded paramaters as appliucable for the method | -| `Optional` subscription | `SubscriptionHandler` | Subscription details (internally used) | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, callback: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> - -*Defined in [ws/Provider.ts:223](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L223)* - -*__name__*: subscribe - -*__summary__*: Allows subscribing to a specific event. - -*__example__*: - -```javascript -const provider = new WsProvider('ws://127.0.0.1:9944'); -const rpc = new Rpc(provider); - -rpc.state.subscribeStorage([[storage.balances.freeBalance,
]], (_, values) => { - console.log(values) -}).then((subscriptionId) => { - console.log('balance changes subscription id: ', subscriptionId) -}) -``` - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| type | `string` | Subscription type | -| method | `string` | Subscription method | -| params | `Array`<`any`> | Parameters | -| callback | [ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback) | Callback | - -**Returns:** `Promise`<`number`> -Promise resolving to the dd of the subscription you can use with [[unsubscribe]]. - -___ - - -## unsubscribe - -▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Defined in [ws/Provider.ts:232](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/ws/Provider.ts#L232)* - -*__summary__*: Allows unsubscribing to subscriptions made with [subscribe](_ws_provider_.wsprovider.md#subscribe). - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/rpc-provider/index.html b/docs/rpc-provider/index.html deleted file mode 100644 index c6ac5d5655..0000000000 --- a/docs/rpc-provider/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/rpc-provider

Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.

Provider Selection

There are two flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets. It is generally recommended to use the WsProvider since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.

Both providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection.

Usage

Installation -

yarn add @polkadot/rpc-provider
-
1

WebSocket Initialisation -

import WsProvider from '@polkadot/rpc-provider/ws';
-
-// this is the actual default endpoint
-const provider = new WsProvider('ws://127.0.0.1:9944');
-const version = await provider.send('client_version', []);
-
-console.log('client version', version);
-
1
2
3
4
5
6
7

HTTP Initialisation -

import { HttpProvider } from '@polkadot/rpc-provider';
-
-// this is the actual default endpoint
-const provider = new HttpProvider('http://127.0.0.1:9933');
-const version = await provider.send('chain_getBlockHash', []);
-
-console.log('latest block Hash', hash);
-
1
2
3
4
5
6
7

Classes

Classes

- - - diff --git a/docs/rpc-provider/interfaces/_types_.providerinterface.html b/docs/rpc-provider/interfaces/_types_.providerinterface.html deleted file mode 100644 index cad2a640d5..0000000000 --- a/docs/rpc-provider/interfaces/_types_.providerinterface.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

ProviderInterface

Properties

hasSubscriptions

● hasSubscriptions: boolean

Defined in types.ts:45

Methods

clone

▸ clone(): ProviderInterface

Defined in types.ts:46

Returns: ProviderInterface

disconnect

▸ disconnect(): void

Defined in types.ts:47

Returns: void

isConnected

▸ isConnected(): boolean

Defined in types.ts:48

Returns: boolean

on

▸ on(type: ProviderInterface$Emitted, sub: ProviderInterface$EmitCb): void

Defined in types.ts:49

Parameters:

Name Type
type ProviderInterface$Emitted
sub ProviderInterface$EmitCb

Returns: void

send

▸ send(method: string, params: Array<any>): Promise<any>

Defined in types.ts:50

Parameters:

Name Type
method string
params Array<any>

Returns: Promise<any>

subscribe

▸ subscribe(type: string, method: string, params: Array<any>, cb: ProviderInterface$Callback): Promise<number>

Defined in types.ts:51

Parameters:

Name Type
type string
method string
params Array<any>
cb ProviderInterface$Callback

Returns: Promise<number>

unsubscribe

▸ unsubscribe(type: string, method: string, id: number): Promise<boolean>

Defined in types.ts:52

Parameters:

Name Type
type string
method string
id number

Returns: Promise<boolean>

- - - diff --git a/docs/rpc-provider/interfaces/_types_.providerinterface.md b/docs/rpc-provider/interfaces/_types_.providerinterface.md deleted file mode 100644 index 44624f16d5..0000000000 --- a/docs/rpc-provider/interfaces/_types_.providerinterface.md +++ /dev/null @@ -1,129 +0,0 @@ - - -# Hierarchy - -**ProviderInterface** - -# Properties - - - -## hasSubscriptions - -**● hasSubscriptions**: *`boolean`* - -*Defined in [types.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L45)* - -___ - -# Methods - - - -## clone - -▸ **clone**(): [ProviderInterface](_types_.providerinterface.md) - -*Defined in [types.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L46)* - -**Returns:** [ProviderInterface](_types_.providerinterface.md) - -___ - - -## disconnect - -▸ **disconnect**(): `void` - -*Defined in [types.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L47)* - -**Returns:** `void` - -___ - - -## isConnected - -▸ **isConnected**(): `boolean` - -*Defined in [types.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L48)* - -**Returns:** `boolean` - -___ - - -## on - -▸ **on**(type: *[ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted)*, sub: *[ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb)*): `void` - -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L49)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | [ProviderInterface$Emitted](../modules/_types_.md#providerinterface_emitted) | -| sub | [ProviderInterface$EmitCb](../modules/_types_.md#providerinterface_emitcb) | - -**Returns:** `void` - -___ - - -## send - -▸ **send**(method: *`string`*, params: *`Array`<`any`>*): `Promise`<`any`> - -*Defined in [types.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L50)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| method | `string` | -| params | `Array`<`any`> | - -**Returns:** `Promise`<`any`> - -___ - - -## subscribe - -▸ **subscribe**(type: *`string`*, method: *`string`*, params: *`Array`<`any`>*, cb: *[ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback)*): `Promise`<`number`> - -*Defined in [types.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L51)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| params | `Array`<`any`> | -| cb | [ProviderInterface$Callback](../modules/_types_.md#providerinterface_callback) | - -**Returns:** `Promise`<`number`> - -___ - - -## unsubscribe - -▸ **unsubscribe**(type: *`string`*, method: *`string`*, id: *`number`*): `Promise`<`boolean`> - -*Defined in [types.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L52)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | `string` | -| method | `string` | -| id | `number` | - -**Returns:** `Promise`<`boolean`> - -___ - diff --git a/docs/rpc-provider/modules/_defaults_.html b/docs/rpc-provider/modules/_defaults_.html deleted file mode 100644 index 52d1509158..0000000000 --- a/docs/rpc-provider/modules/_defaults_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-provider/modules/_defaults_.md b/docs/rpc-provider/modules/_defaults_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/rpc-provider/modules/_defaults_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/rpc-provider/modules/_http_polyfill_.html b/docs/rpc-provider/modules/_http_polyfill_.html deleted file mode 100644 index cd3888a393..0000000000 --- a/docs/rpc-provider/modules/_http_polyfill_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-provider/modules/_http_polyfill_.md b/docs/rpc-provider/modules/_http_polyfill_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/rpc-provider/modules/_http_polyfill_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/rpc-provider/modules/_http_types_.html b/docs/rpc-provider/modules/_http_types_.html deleted file mode 100644 index 97c6be82dc..0000000000 --- a/docs/rpc-provider/modules/_http_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-provider/modules/_http_types_.md b/docs/rpc-provider/modules/_http_types_.md deleted file mode 100644 index 26061c4fc7..0000000000 --- a/docs/rpc-provider/modules/_http_types_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Type aliases - - - -## HttpState - -**Ƭ HttpState**: *`object`* - -*Defined in [http/types.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/http/types.ts#L9)* - -#### Type declaration - -___ - diff --git a/docs/rpc-provider/modules/_mock_types_.html b/docs/rpc-provider/modules/_mock_types_.html deleted file mode 100644 index d114b41805..0000000000 --- a/docs/rpc-provider/modules/_mock_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - -
polkadot-js/api

Type aliases

MockState$Db

Ƭ MockState$Db: object

Defined in mock/types.ts:16

Type declaration

MockState$Requests

Ƭ MockState$Requests: object

Defined in mock/types.ts:20

Type declaration

▸(db: MockState$Db, params: Array<any>): string

Parameters:

Name Type
db MockState$Db
params Array<any>

Returns: string

MockState$Subscription$Callback

Ƭ MockState$Subscription$Callback: function

Defined in mock/types.ts:5

Type declaration

▸(error: Error | null, value: any): void

Parameters:

Name Type
error Error | null
value any

Returns: void

MockState$Subscriptions

Ƭ MockState$Subscriptions: object

Defined in mock/types.ts:7

Type declaration

- - - diff --git a/docs/rpc-provider/modules/_mock_types_.md b/docs/rpc-provider/modules/_mock_types_.md deleted file mode 100644 index 5cf70c5319..0000000000 --- a/docs/rpc-provider/modules/_mock_types_.md +++ /dev/null @@ -1,76 +0,0 @@ - - -# Type aliases - - - -## MockState$Db - -**Ƭ MockState$Db**: *`object`* - -*Defined in [mock/types.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L16)* - -#### Type declaration - -[index: `string`]: `Uint8Array` - -___ - - -## MockState$Requests - -**Ƭ MockState$Requests**: *`object`* - -*Defined in [mock/types.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L20)* - -#### Type declaration - -[index: `string`]: `function` - -▸(db: *[MockState$Db](_mock_types_.md#mockstate_db)*, params: *`Array`<`any`>*): `string` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| db | [MockState$Db](_mock_types_.md#mockstate_db) | -| params | `Array`<`any`> | - -**Returns:** `string` - -___ - - -## MockState$Subscription$Callback - -**Ƭ MockState$Subscription$Callback**: *`function`* - -*Defined in [mock/types.ts:5](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L5)* - -#### Type declaration -▸(error: *`Error` \| `null`*, value: *`any`*): `void` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| error | `Error` \| `null` | -| value | `any` | - -**Returns:** `void` - -___ - - -## MockState$Subscriptions - -**Ƭ MockState$Subscriptions**: *`object`* - -*Defined in [mock/types.ts:7](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/mock/types.ts#L7)* - -#### Type declaration - -[index: `string`]: `object` - -___ - diff --git a/docs/rpc-provider/modules/_types_.html b/docs/rpc-provider/modules/_types_.html deleted file mode 100644 index 21f4746ffa..0000000000 --- a/docs/rpc-provider/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - -
polkadot-js/api

Index

Interfaces

Type aliases

Type aliases

JsonRpcObject

Ƭ JsonRpcObject: object

Defined in types.ts:5

Type declaration

JsonRpcRequest

Ƭ JsonRpcRequest: JsonRpcObject & object

Defined in types.ts:10

JsonRpcResponse

Ƭ JsonRpcResponse: JsonRpcObject & JsonRpcResponseBase

Defined in types.ts:36

JsonRpcResponseBase

Ƭ JsonRpcResponseBase: JsonRpcResponse$Single & JsonRpcResponse$Subscription

Defined in types.ts:34

JsonRpcResponseBase$Error

Ƭ JsonRpcResponseBase$Error: object

Defined in types.ts:15

Type declaration

ProviderInterface$Callback

Ƭ ProviderInterface$Callback: function

Defined in types.ts:38

Type declaration

▸(result: any): void

Parameters:

Name Type
result any

Returns: void

ProviderInterface$EmitCb

Ƭ ProviderInterface$EmitCb: function

Defined in types.ts:42

Type declaration

▸(value?: any): any

Parameters:

Name Type
Optional value any

Returns: any

ProviderInterface$Emitted

Ƭ ProviderInterface$Emitted: "connected" | "disconnected" | "error"

Defined in types.ts:40

- - - diff --git a/docs/rpc-provider/modules/_types_.md b/docs/rpc-provider/modules/_types_.md deleted file mode 100644 index 4c70b00f4f..0000000000 --- a/docs/rpc-provider/modules/_types_.md +++ /dev/null @@ -1,122 +0,0 @@ - - -# Index - -### Interfaces - -* [ProviderInterface](../interfaces/_types_.providerinterface.md) - -### Type aliases - -* [JsonRpcObject](_types_.md#jsonrpcobject) -* [JsonRpcRequest](_types_.md#jsonrpcrequest) -* [JsonRpcResponse](_types_.md#jsonrpcresponse) -* [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase) -* [JsonRpcResponseBase$Error](_types_.md#jsonrpcresponsebase_error) -* [ProviderInterface$Callback](_types_.md#providerinterface_callback) -* [ProviderInterface$EmitCb](_types_.md#providerinterface_emitcb) -* [ProviderInterface$Emitted](_types_.md#providerinterface_emitted) - ---- - -# Type aliases - - - -## JsonRpcObject - -**Ƭ JsonRpcObject**: *`object`* - -*Defined in [types.ts:5](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L5)* - -#### Type declaration - -___ - - -## JsonRpcRequest - -**Ƭ JsonRpcRequest**: *[JsonRpcObject](_types_.md#jsonrpcobject) & `object`* - -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L10)* - -___ - - -## JsonRpcResponse - -**Ƭ JsonRpcResponse**: *[JsonRpcObject](_types_.md#jsonrpcobject) & [JsonRpcResponseBase](_types_.md#jsonrpcresponsebase)* - -*Defined in [types.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L36)* - -___ - - -## JsonRpcResponseBase - -**Ƭ JsonRpcResponseBase**: *`JsonRpcResponse$Single` & `JsonRpcResponse$Subscription`* - -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L34)* - -___ - - -## JsonRpcResponseBase$Error - -**Ƭ JsonRpcResponseBase$Error**: *`object`* - -*Defined in [types.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L15)* - -#### Type declaration - -___ - - -## ProviderInterface$Callback - -**Ƭ ProviderInterface$Callback**: *`function`* - -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L38)* - -#### Type declaration -▸(result: *`any`*): `void` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| result | `any` | - -**Returns:** `void` - -___ - - -## ProviderInterface$EmitCb - -**Ƭ ProviderInterface$EmitCb**: *`function`* - -*Defined in [types.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L42)* - -#### Type declaration -▸(value?: *`any`*): `any` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** `any` - -___ - - -## ProviderInterface$Emitted - -**Ƭ ProviderInterface$Emitted**: *"connected" \| "disconnected" \| "error"* - -*Defined in [types.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-provider/src/types.ts#L40)* - -___ - diff --git a/docs/rpc-provider/modules/_ws_polyfill_.html b/docs/rpc-provider/modules/_ws_polyfill_.html deleted file mode 100644 index a9b99f4e06..0000000000 --- a/docs/rpc-provider/modules/_ws_polyfill_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-provider/modules/_ws_polyfill_.md b/docs/rpc-provider/modules/_ws_polyfill_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/rpc-provider/modules/_ws_polyfill_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/rpc-provider/modules/_ws_provider_.html b/docs/rpc-provider/modules/_ws_provider_.html deleted file mode 100644 index 39b4c59357..0000000000 --- a/docs/rpc-provider/modules/_ws_provider_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-provider/modules/_ws_provider_.md b/docs/rpc-provider/modules/_ws_provider_.md deleted file mode 100644 index c582bfe10a..0000000000 --- a/docs/rpc-provider/modules/_ws_provider_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [WsProvider](../classes/_ws_provider_.wsprovider.md) - ---- - diff --git a/docs/rpc-rx/README.md b/docs/rpc-rx/README.md deleted file mode 100644 index 965087ff49..0000000000 --- a/docs/rpc-rx/README.md +++ /dev/null @@ -1,11 +0,0 @@ - -@polkadot/rpc-rx -================ - -An RxJs wrapper around the [@polkadot/rpc-core](../rpc-core). - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/rpc-rx/SUMMARY.html b/docs/rpc-rx/SUMMARY.html deleted file mode 100644 index 6602f0deea..0000000000 --- a/docs/rpc-rx/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-rx/SUMMARY.md b/docs/rpc-rx/SUMMARY.md deleted file mode 100644 index 9f21b0b574..0000000000 --- a/docs/rpc-rx/SUMMARY.md +++ /dev/null @@ -1 +0,0 @@ -* ["types"](modules/_types_.md) diff --git a/docs/rpc-rx/index.html b/docs/rpc-rx/index.html deleted file mode 100644 index 1bb8850328..0000000000 --- a/docs/rpc-rx/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/rpc-rx/modules/_types_.html b/docs/rpc-rx/modules/_types_.html deleted file mode 100644 index a2dfe5c610..0000000000 --- a/docs/rpc-rx/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - -
polkadot-js/api

Type aliases

RpcRxInterface

Ƭ RpcRxInterface: object

Defined in types.ts:16

Type declaration

RpcRxInterface$Events

Ƭ RpcRxInterface$Events: ProviderInterface$Emitted

Defined in types.ts:14

RpcRxInterface$Method

Ƭ RpcRxInterface$Method: function

Defined in types.ts:8

Type declaration

▸(...params: Array<any>): Observable<any>

Parameters:

Name Type
Rest params Array<any>

Returns: Observable<any>

RpcRxInterface$Section

Ƭ RpcRxInterface$Section: object

Defined in types.ts:10

Type declaration

- - - diff --git a/docs/rpc-rx/modules/_types_.md b/docs/rpc-rx/modules/_types_.md deleted file mode 100644 index 33c20ee254..0000000000 --- a/docs/rpc-rx/modules/_types_.md +++ /dev/null @@ -1,58 +0,0 @@ - - -# Type aliases - - - -## RpcRxInterface - -**Ƭ RpcRxInterface**: *`object`* - -*Defined in [types.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L16)* - -#### Type declaration - -___ - - -## RpcRxInterface$Events - -**Ƭ RpcRxInterface$Events**: *`ProviderInterface$Emitted`* - -*Defined in [types.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L14)* - -___ - - -## RpcRxInterface$Method - -**Ƭ RpcRxInterface$Method**: *`function`* - -*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L8)* - -#### Type declaration -▸(...params: *`Array`<`any`>*): `Observable`<`any`> - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` params | `Array`<`any`> | - -**Returns:** `Observable`<`any`> - -___ - - -## RpcRxInterface$Section - -**Ƭ RpcRxInterface$Section**: *`object`* - -*Defined in [types.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/rpc-rx/src/types.ts#L10)* - -#### Type declaration - -[index: `string`]: [RpcRxInterface$Method](_types_.md#rpcrxinterface_method) - -___ - diff --git a/docs/type-extrinsics/README.md b/docs/type-extrinsics/README.md deleted file mode 100644 index c4ec28bb6c..0000000000 --- a/docs/type-extrinsics/README.md +++ /dev/null @@ -1,11 +0,0 @@ - -@polkadot/extrinsics -==================== - -Base extrinsic definitions & codecs - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/type-extrinsics/SUMMARY.html b/docs/type-extrinsics/SUMMARY.html deleted file mode 100644 index 25c55e4fe7..0000000000 --- a/docs/type-extrinsics/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-extrinsics/SUMMARY.md b/docs/type-extrinsics/SUMMARY.md deleted file mode 100644 index 5c392e97f2..0000000000 --- a/docs/type-extrinsics/SUMMARY.md +++ /dev/null @@ -1,3 +0,0 @@ -* ["fromMetadata"](modules/_frommetadata_.md) -* ["static"](modules/_static_.md) -* ["utils/createUnchecked"](modules/_utils_createunchecked_.md) diff --git a/docs/type-extrinsics/index.html b/docs/type-extrinsics/index.html deleted file mode 100644 index e3cf5e5006..0000000000 --- a/docs/type-extrinsics/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-extrinsics/modules/_frommetadata_.html b/docs/type-extrinsics/modules/_frommetadata_.html deleted file mode 100644 index b6f81426d6..0000000000 --- a/docs/type-extrinsics/modules/_frommetadata_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-extrinsics/modules/_frommetadata_.md b/docs/type-extrinsics/modules/_frommetadata_.md deleted file mode 100644 index 33394c6ce1..0000000000 --- a/docs/type-extrinsics/modules/_frommetadata_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## fromMetadata - -▸ **fromMetadata**(metadata: *`MetadataV0`*): `ModulesWithMethods` - -*Defined in [fromMetadata.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-extrinsics/src/fromMetadata.ts#L21)* - -Extend a storage object with the storage modules & module functions present in the metadata. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| metadata | `MetadataV0` | The metadata to extend the storage object against. | - -**Returns:** `ModulesWithMethods` - -___ - diff --git a/docs/type-extrinsics/modules/_static_.html b/docs/type-extrinsics/modules/_static_.html deleted file mode 100644 index d913a36b5b..0000000000 --- a/docs/type-extrinsics/modules/_static_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-extrinsics/modules/_static_.md b/docs/type-extrinsics/modules/_static_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/type-extrinsics/modules/_static_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/type-extrinsics/modules/_utils_createunchecked_.html b/docs/type-extrinsics/modules/_utils_createunchecked_.html deleted file mode 100644 index 050ac39bc6..0000000000 --- a/docs/type-extrinsics/modules/_utils_createunchecked_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - -
polkadot-js/api

Functions

createDescriptor

▸ createDescriptor(section: string, method: string, index: number, meta: FunctionMetadata): MethodFunction

Defined in utils/createUnchecked.ts:16

From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic.

Parameters:

Name Type Description
section string
method string
index number Index of the module section in the modules array.
meta FunctionMetadata

Returns: MethodFunction

- - - diff --git a/docs/type-extrinsics/modules/_utils_createunchecked_.md b/docs/type-extrinsics/modules/_utils_createunchecked_.md deleted file mode 100644 index 64edce6094..0000000000 --- a/docs/type-extrinsics/modules/_utils_createunchecked_.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# Functions - - - -## createDescriptor - -▸ **createDescriptor**(section: *`string`*, method: *`string`*, index: *`number`*, meta: *`FunctionMetadata`*): `MethodFunction` - -*Defined in [utils/createUnchecked.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-extrinsics/src/utils/createUnchecked.ts#L16)* - -From the metadata of a function in the module's storage, generate the function that will return the an UncheckExtrinsic. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| section | `string` | -| method | `string` | -| index | `number` | Index of the module section in the modules array. | -| meta | `FunctionMetadata` | - -**Returns:** `MethodFunction` - -___ - diff --git a/docs/type-jsonrpc/README.md b/docs/type-jsonrpc/README.md deleted file mode 100644 index c7cde9a33d..0000000000 --- a/docs/type-jsonrpc/README.md +++ /dev/null @@ -1,30 +0,0 @@ - -@polkadot/jsonrpc -================= - -A definition of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking. - -For a list of currently exposed methods, see the [method documentation](docs/METHODS_RPC.md). - -Usage ------ - -Installation - - -``` -yarn add @polkadot/jsonrpc -``` - -Adding methods --------------- - -As methods are added, simply adding the name, inputs & output will prepare it for use. - -* Add the method to the correct file in [src/rpc/](src/rpc/) (Input/Output types as cross-referenced from the canonical implementation and match one-to-one) -* Should a new type be required, add it to the type list, [src/types.js](src/types.js) (Required for TSLint type checking) - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/type-jsonrpc/SUMMARY.html b/docs/type-jsonrpc/SUMMARY.html deleted file mode 100644 index 1be7154a1f..0000000000 --- a/docs/type-jsonrpc/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/SUMMARY.md b/docs/type-jsonrpc/SUMMARY.md deleted file mode 100644 index a5e01df81f..0000000000 --- a/docs/type-jsonrpc/SUMMARY.md +++ /dev/null @@ -1,7 +0,0 @@ -* ["author"](modules/_author_.md) -* ["chain"](modules/_chain_.md) -* ["create/method"](modules/_create_method_.md) -* ["create/param"](modules/_create_param_.md) -* ["state"](modules/_state_.md) -* ["system"](modules/_system_.md) -* ["types"](modules/_types_.md) diff --git a/docs/type-jsonrpc/index.html b/docs/type-jsonrpc/index.html deleted file mode 100644 index 8ebf25525a..0000000000 --- a/docs/type-jsonrpc/index.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/jsonrpc

A definition of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking.

For a list of currently exposed methods, see the method documentation.

Usage

Installation -

yarn add @polkadot/jsonrpc
-
1

Adding methods

As methods are added, simply adding the name, inputs & output will prepare it for use.

  • Add the method to the correct file in src/rpc/ (Input/Output types as cross-referenced from the canonical implementation and match one-to-one)
  • Should a new type be required, add it to the type list, src/types.js (Required for TSLint type checking)

Classes

Classes

- - - diff --git a/docs/type-jsonrpc/modules/_author_.html b/docs/type-jsonrpc/modules/_author_.html deleted file mode 100644 index 01ab1db74a..0000000000 --- a/docs/type-jsonrpc/modules/_author_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/modules/_author_.md b/docs/type-jsonrpc/modules/_author_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/type-jsonrpc/modules/_author_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/type-jsonrpc/modules/_chain_.html b/docs/type-jsonrpc/modules/_chain_.html deleted file mode 100644 index 54ede7c768..0000000000 --- a/docs/type-jsonrpc/modules/_chain_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/modules/_chain_.md b/docs/type-jsonrpc/modules/_chain_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/type-jsonrpc/modules/_chain_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/type-jsonrpc/modules/_create_method_.html b/docs/type-jsonrpc/modules/_create_method_.html deleted file mode 100644 index 93cc2580f0..0000000000 --- a/docs/type-jsonrpc/modules/_create_method_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/modules/_create_method_.md b/docs/type-jsonrpc/modules/_create_method_.md deleted file mode 100644 index b1ef64eb65..0000000000 --- a/docs/type-jsonrpc/modules/_create_method_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## createMethod - -▸ **createMethod**(section: *`string`*, method: *`string`*, __namedParameters: *`object`*): [RpcMethod](_types_.md#rpcmethod) - -*Defined in [create/method.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/create/method.ts#L9)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| section | `string` | -| method | `string` | -| __namedParameters | `object` | - -**Returns:** [RpcMethod](_types_.md#rpcmethod) - -___ - diff --git a/docs/type-jsonrpc/modules/_create_param_.html b/docs/type-jsonrpc/modules/_create_param_.html deleted file mode 100644 index c6e6dd2ba9..0000000000 --- a/docs/type-jsonrpc/modules/_create_param_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/modules/_create_param_.md b/docs/type-jsonrpc/modules/_create_param_.md deleted file mode 100644 index 3e5cc629f8..0000000000 --- a/docs/type-jsonrpc/modules/_create_param_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## createParam - -▸ **createParam**(name: *`string`*, type: *`CodecTypes`*, __namedParameters?: *`object`*): [RpcParam](_types_.md#rpcparam) - -*Defined in [create/param.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/create/param.ts#L12)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| name | `string` | - | -| type | `CodecTypes` | - | -| `Default value` __namedParameters | `object` | { isOptional: false } | - -**Returns:** [RpcParam](_types_.md#rpcparam) - -___ - diff --git a/docs/type-jsonrpc/modules/_state_.html b/docs/type-jsonrpc/modules/_state_.html deleted file mode 100644 index 70ea0b14e4..0000000000 --- a/docs/type-jsonrpc/modules/_state_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/modules/_state_.md b/docs/type-jsonrpc/modules/_state_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/type-jsonrpc/modules/_state_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/type-jsonrpc/modules/_system_.html b/docs/type-jsonrpc/modules/_system_.html deleted file mode 100644 index 74448a642c..0000000000 --- a/docs/type-jsonrpc/modules/_system_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/modules/_system_.md b/docs/type-jsonrpc/modules/_system_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/type-jsonrpc/modules/_system_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/type-jsonrpc/modules/_types_.html b/docs/type-jsonrpc/modules/_types_.html deleted file mode 100644 index a878d46b48..0000000000 --- a/docs/type-jsonrpc/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-jsonrpc/modules/_types_.md b/docs/type-jsonrpc/modules/_types_.md deleted file mode 100644 index cabb118869..0000000000 --- a/docs/type-jsonrpc/modules/_types_.md +++ /dev/null @@ -1,49 +0,0 @@ - - -# Type aliases - - - -## RpcMethod - -**Ƭ RpcMethod**: *`object`* - -*Defined in [types.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L24)* - -#### Type declaration - -___ - - -## RpcMethodOpt - -**Ƭ RpcMethodOpt**: *`object`* - -*Defined in [types.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L13)* - -#### Type declaration - -___ - - -## RpcParam - -**Ƭ RpcParam**: *`object`* - -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L7)* - -#### Type declaration - -___ - - -## RpcSection - -**Ƭ RpcSection**: *`object`* - -*Defined in [types.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-jsonrpc/src/types.ts#L38)* - -#### Type declaration - -___ - diff --git a/docs/type-storage/README.md b/docs/type-storage/README.md deleted file mode 100644 index 1925421ef7..0000000000 --- a/docs/type-storage/README.md +++ /dev/null @@ -1,11 +0,0 @@ - -@polkadot/storage -================= - -An base interface to the storage layer - -Classes -------- - -[Classes](SUMMARY.md) - diff --git a/docs/type-storage/SUMMARY.html b/docs/type-storage/SUMMARY.html deleted file mode 100644 index 50eed432c3..0000000000 --- a/docs/type-storage/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/SUMMARY.md b/docs/type-storage/SUMMARY.md deleted file mode 100644 index 6cd6300924..0000000000 --- a/docs/type-storage/SUMMARY.md +++ /dev/null @@ -1,9 +0,0 @@ -* ["fromMetadata"](modules/_frommetadata_.md) -* ["static"](modules/_static_.md) -* ["storage"](modules/_storage_.md) -* ["substrate"](modules/_substrate_.md) -* ["types"](modules/_types_.md) - * [ModuleStorage](interfaces/_types_.modulestorage.md) - * [Storage](interfaces/_types_.storage.md) -* ["utils/createFunction"](modules/_utils_createfunction_.md) - * [CreateItemOptions](interfaces/_utils_createfunction_.createitemoptions.md) diff --git a/docs/type-storage/index.html b/docs/type-storage/index.html deleted file mode 100644 index 9e04043dd0..0000000000 --- a/docs/type-storage/index.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/interfaces/_types_.modulestorage.html b/docs/type-storage/interfaces/_types_.modulestorage.html deleted file mode 100644 index 65f5a53720..0000000000 --- a/docs/type-storage/interfaces/_types_.modulestorage.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/interfaces/_types_.modulestorage.md b/docs/type-storage/interfaces/_types_.modulestorage.md deleted file mode 100644 index 845cbffa4c..0000000000 --- a/docs/type-storage/interfaces/_types_.modulestorage.md +++ /dev/null @@ -1,9 +0,0 @@ - - -# Hierarchy - -**ModuleStorage** - -# Indexable - -\[key: `string`\]: `StorageFunction` diff --git a/docs/type-storage/interfaces/_types_.storage.html b/docs/type-storage/interfaces/_types_.storage.html deleted file mode 100644 index 710b8269da..0000000000 --- a/docs/type-storage/interfaces/_types_.storage.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/interfaces/_types_.storage.md b/docs/type-storage/interfaces/_types_.storage.md deleted file mode 100644 index c5ac1694de..0000000000 --- a/docs/type-storage/interfaces/_types_.storage.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# Hierarchy - -**Storage** - -# Indexable - -\[key: `string`\]: [ModuleStorage](_types_.modulestorage.md) -# Properties - - - -## substrate - -**● substrate**: *`object`* - -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/types.ts#L17)* - -#### Type declaration - -___ - diff --git a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.html b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.html deleted file mode 100644 index 4c9074502f..0000000000 --- a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md b/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md deleted file mode 100644 index 359fbe35f1..0000000000 --- a/docs/type-storage/interfaces/_utils_createfunction_.createitemoptions.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# Hierarchy - -**CreateItemOptions** - -# Properties - - - -## `` isUnhashed - -**● isUnhashed**: *`undefined` \| `false` \| `true`* - -*Defined in [utils/createFunction.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/utils/createFunction.ts#L12)* - -___ - - -## `` key - -**● key**: *`undefined` \| `string`* - -*Defined in [utils/createFunction.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/utils/createFunction.ts#L13)* - -___ - diff --git a/docs/type-storage/modules/_frommetadata_.html b/docs/type-storage/modules/_frommetadata_.html deleted file mode 100644 index af5b38261e..0000000000 --- a/docs/type-storage/modules/_frommetadata_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md deleted file mode 100644 index 10d693076f..0000000000 --- a/docs/type-storage/modules/_frommetadata_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Functions - - - -## fromMetadata - -▸ **fromMetadata**(metadata: *`MetadataV0`*): [Storage](../interfaces/_types_.storage.md) - -*Defined in [fromMetadata.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/fromMetadata.ts#L20)* - -Extend a storage object with the storage modules & module functions present in the metadata. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| metadata | `MetadataV0` | The metadata to extend the storage object against. | - -**Returns:** [Storage](../interfaces/_types_.storage.md) - -___ - diff --git a/docs/type-storage/modules/_static_.html b/docs/type-storage/modules/_static_.html deleted file mode 100644 index c6a6e07ebb..0000000000 --- a/docs/type-storage/modules/_static_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/modules/_static_.md b/docs/type-storage/modules/_static_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/type-storage/modules/_static_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/type-storage/modules/_storage_.html b/docs/type-storage/modules/_storage_.html deleted file mode 100644 index a16ea4f483..0000000000 --- a/docs/type-storage/modules/_storage_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Object literals | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/modules/_storage_.md b/docs/type-storage/modules/_storage_.md deleted file mode 100644 index 24db4cfb1c..0000000000 --- a/docs/type-storage/modules/_storage_.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Object literals - - - -## `` storage - -**storage**: *`object`* - -*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/storage.ts#L8)* - - - -### substrate - -**● substrate**: *["substrate"](_substrate_.md)* - -*Defined in [storage.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/storage.ts#L9)* - -___ - -___ - diff --git a/docs/type-storage/modules/_substrate_.html b/docs/type-storage/modules/_substrate_.html deleted file mode 100644 index 3a10679549..0000000000 --- a/docs/type-storage/modules/_substrate_.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - Variables | polkadot-js/api - - - - - - - -
polkadot-js/api

Variables

<Const> authorityCount

● authorityCount: StorageFunction = createRuntimeFunction('authorityCount', ':auth:len', { -documentation: 'Number of authorities.', -type: 'u32' -})

Defined in substrate.ts:44

<Const> authorityPrefix

● authorityPrefix: StorageFunction = createRuntimeFunction('authorityPrefix', ':auth:', { -documentation: 'Prefix under which authorities are storied.', -type: 'u32' -})

Defined in substrate.ts:49

<Const> changesTrieConfig

● changesTrieConfig: StorageFunction = createRuntimeFunction('changesTrieConfig', ':changes_trie', { -documentation: 'Changes trie configuration is stored under this key.', -type: 'u32' -})

Defined in substrate.ts:59

<Const> code

● code: StorageFunction = createRuntimeFunction('code', ':code', { -documentation: 'Wasm code of the runtime.', -type: 'Bytes' -})

Defined in substrate.ts:34

<Const> extrinsicIndex

● extrinsicIndex: StorageFunction = createRuntimeFunction('extrinsicIndex', ':extrinsic_index', { -documentation: 'Current extrinsic index (u32) is stored under this key.', -type: 'u32' -})

Defined in substrate.ts:54

<Const> heapPages

● heapPages: StorageFunction = createRuntimeFunction('heapPages', ':heappages', { -documentation: 'Number of wasm linear memory pages required for execution of the runtime.', -type: 'u64' -})

Defined in substrate.ts:39

- - - diff --git a/docs/type-storage/modules/_substrate_.md b/docs/type-storage/modules/_substrate_.md deleted file mode 100644 index f78667904f..0000000000 --- a/docs/type-storage/modules/_substrate_.md +++ /dev/null @@ -1,77 +0,0 @@ - - -# Variables - - - -## `` authorityCount - -**● authorityCount**: *`StorageFunction`* = createRuntimeFunction('authorityCount', ':auth:len', { - documentation: 'Number of authorities.', - type: 'u32' -}) - -*Defined in [substrate.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L44)* - -___ - - -## `` authorityPrefix - -**● authorityPrefix**: *`StorageFunction`* = createRuntimeFunction('authorityPrefix', ':auth:', { - documentation: 'Prefix under which authorities are storied.', - type: 'u32' -}) - -*Defined in [substrate.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L49)* - -___ - - -## `` changesTrieConfig - -**● changesTrieConfig**: *`StorageFunction`* = createRuntimeFunction('changesTrieConfig', ':changes_trie', { - documentation: 'Changes trie configuration is stored under this key.', - type: 'u32' -}) - -*Defined in [substrate.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L59)* - -___ - - -## `` code - -**● code**: *`StorageFunction`* = createRuntimeFunction('code', ':code', { - documentation: 'Wasm code of the runtime.', - type: 'Bytes' -}) - -*Defined in [substrate.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L34)* - -___ - - -## `` extrinsicIndex - -**● extrinsicIndex**: *`StorageFunction`* = createRuntimeFunction('extrinsicIndex', ':extrinsic_index', { - documentation: 'Current extrinsic index (u32) is stored under this key.', - type: 'u32' -}) - -*Defined in [substrate.ts:54](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L54)* - -___ - - -## `` heapPages - -**● heapPages**: *`StorageFunction`* = createRuntimeFunction('heapPages', ':heappages', { - documentation: 'Number of wasm linear memory pages required for execution of the runtime.', - type: 'u64' -}) - -*Defined in [substrate.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/substrate.ts#L39)* - -___ - diff --git a/docs/type-storage/modules/_types_.html b/docs/type-storage/modules/_types_.html deleted file mode 100644 index 2de8e29c10..0000000000 --- a/docs/type-storage/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/type-storage/modules/_types_.md b/docs/type-storage/modules/_types_.md deleted file mode 100644 index 883b7d4845..0000000000 --- a/docs/type-storage/modules/_types_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Interfaces - -* [ModuleStorage](../interfaces/_types_.modulestorage.md) -* [Storage](../interfaces/_types_.storage.md) - ---- - diff --git a/docs/type-storage/modules/_utils_createfunction_.html b/docs/type-storage/modules/_utils_createfunction_.html deleted file mode 100644 index 6bf0e8ed02..0000000000 --- a/docs/type-storage/modules/_utils_createfunction_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - -
polkadot-js/api

Index

Interfaces

Functions

Functions

createFunction

▸ createFunction(section: Text | string, method: Text | string, meta: StorageFunctionMetadata, options?: CreateItemOptions): StorageFunction

Defined in utils/createFunction.ts:26

From the schema of a function in the module's storage, generate the function that will return the correct storage key.

Parameters:

Name Type Default value Description
section Text | string -
method Text | string -
meta StorageFunctionMetadata -
Default value options CreateItemOptions {} Additional options when creating the function. These options are not known at runtime (from state_getMetadata), they need to be supplied by us manually at compile time.

Returns: StorageFunction

- - - diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md deleted file mode 100644 index 7d8aa1bb46..0000000000 --- a/docs/type-storage/modules/_utils_createfunction_.md +++ /dev/null @@ -1,39 +0,0 @@ - - -# Index - -### Interfaces - -* [CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md) - -### Functions - -* [createFunction](_utils_createfunction_.md#createfunction) - ---- - -# Functions - - - -## createFunction - -▸ **createFunction**(section: *`Text` \| `string`*, method: *`Text` \| `string`*, meta: *`StorageFunctionMetadata`*, options?: *[CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md)*): `StorageFunction` - -*Defined in [utils/createFunction.ts:26](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/type-storage/src/utils/createFunction.ts#L26)* - -From the schema of a function in the module's storage, generate the function that will return the correct storage key. - -**Parameters:** - -| Name | Type | Default value | Description | -| ------ | ------ | ------ | ------ | -| section | `Text` \| `string` | - | -| method | `Text` \| `string` | - | -| meta | `StorageFunctionMetadata` | - | -| `Default value` options | [CreateItemOptions](../interfaces/_utils_createfunction_.createitemoptions.md) | {} | Additional options when creating the function. These options are not known at runtime (from state\_getMetadata), they need to be supplied by us manually at compile time. | - -**Returns:** `StorageFunction` - -___ - diff --git a/docs/types/README.md b/docs/types/README.md deleted file mode 100644 index 37fad32f26..0000000000 --- a/docs/types/README.md +++ /dev/null @@ -1,31 +0,0 @@ - -@polkadot/types -=============== - -Implementation of the types and their (de-)serialisation via [parity-codec](https://github.com/paritytech/parity-codec). - -Primitive types ---------------- - -There primitive types are available: [Bool](classes/_primitive_bool_.bool.md), [Bytes](classes/_primitive_bytes_.bytes.md), [Data](classes/_primitive_data_.data.md), [H160](classes/_primitive_h160_.h160.md), [H256](classes/_primitive_h256_.h256.md), [H512](classes/_primitive_h512_.h512.md), [I8](classes/_primitive_i8_.i8.md), [I16](classes/_primitive_i16_.i16.md), [I32](classes/_primitive_i32_.i32.md), [I64](classes/_primitive_i64_.i64.md), [I128](classes/_primitive_i128_.i128.md), [I256](classes/_primitive_i256_.i256.md), [Method](classes/_primitive_method_.method.md), [Moment](classes/_primitive_moment_.moment.md), [Null](classes/_primitive_null_.null.md), [StorageData](classes/_primitive_storagedata_.storagedata.md), [StorageKey](classes/_primitive_storagekey_.storagekey.md), [Text](classes/_primitive_text_.text.md), [Type](classes/_codec_struct_.struct.md#type), [U8](classes/_primitive_u8_.u8.md), [U16](classes/_primitive_u16_.u16.md), [U32](classes/_primitive_u32_.u32.md), [U64](classes/_primitive_u64_.u64.md), [U128](classes/_primitive_u128_.u128.md), [U256](classes/_primitive_u256_.u256.md), [USize](classes/_primitive_usize_.usize.md) - -Substrate types ---------------- - -These types implement specific types that are found as part of the Substrate base: [AccountId](classes/_type_accountid_.accountid.md), [AccountIndex](classes/_type_accountindex_.accountindex.md), [Address](classes/_type_address_.address.md), [Amount](classes/_type_amount_.amount.md), [AssetOf](classes/_type_assetof_.assetof.md), [AttestedCandidate](classes/_type_attestedcandidate_.attestedcandidate.md), [AuthorityId](classes/_type_authorityid_.authorityid.md), [Balance](classes/_type_balance_.balance.md), [BalanceOf](classes/_type_balance_.balanceof.md), [Block](classes/_type_block_.block.md), [BlockNumber](classes/_type_blocknumber_.blocknumber.md), [CodeHash](classes/_type_codehash_.codehash.md), [Digest](classes/_type_digest_.digest.md), [Event](classes/_type_event_.event.md), [EventRecord](classes/_type_eventrecord_.eventrecord.md), [Extrinsic](classes/_type_extrinsic_.extrinsic.md), [ExtrinsicEra](classes/_type_extrinsicera_.extrinsicera.md), [ExtrinsicSignature](classes/_type_extrinsicsignature_.extrinsicsignature.md), [Gas](classes/_type_gas_.gas.md), [Hash](classes/_type_hash_.hash.md), [Header](classes/_type_header_.header.md), [InherentOfflineReport](classes/_type_inherentofflinereport_.inherentofflinereport.md), [Justification](classes/_type_justification_.justification.md), [KeyValue](classes/_type_keyvalue_.keyvalue.md), [MisbehaviorReport](classes/_type_misbehaviorreport_.misbehaviorreport.md), [NewAccountOutcome](classes/_type_newaccountoutcome_.newaccountoutcome.md), [Nonce](classes/_type_nonce_.nonce.md), [Origin](classes/_type_origin_.origin.md), [ParaId](classes/_type_paraid_.paraid.md), [Perbill](classes/_type_perbill_.perbill.md), [Permill](classes/_type_permill_.permill.md), [PrefabWasmModule](classes/_type_prefabwasmmodule_.prefabwasmmodule.md), [PropIndex](classes/_type_propindex_.propindex.md), [Proposal](classes/_type_proposal_.proposal.md), [ProposalIndex](classes/_type_proposalindex_.proposalindex.md), [ReferendumIndex](classes/_type_referendumindex_.referendumindex.md), [ReferendumInfo](classes/_type_referenduminfo_.referenduminfo.md), [Schedule](classes/_type_schedule_.schedule.md), [SeedOf](classes/_type_seedof_.seedof.md), [SessionKey](classes/_type_sessionkey_.sessionkey.md), [Signature](classes/_type_signature_.signature.md), [SignaturePayload](classes/_type_signaturepayload_.signaturepayload.md), [StoredPendingChange](classes/_type_storedpendingchange_.storedpendingchange.md), [ValidatorPrefs](classes/_type_validatorprefs_.validatorprefs.md), [VestingSchedule](classes/_type_vestingschedule_.vestingschedule.md), [Vote](classes/_type_vote_.vote.md), [VoteIndex](classes/_type_voteindex_.voteindex.md), [VoteThreshold](classes/_type_votethreshold_.votethreshold.md) - -Codec types ------------ - -These are the base types of the codec, typically not used directly, but rather inherited from to create specific types: [Base](classes/_codec_base_.base.md), [Compact](classes/_codec_compact_.compact.md), [Enum](enums/_codec_createtype_.typedefinfo.md#enum), [EnumType](classes/_codec_enumtype_.enumtype.md), [Option](classes/_codec_option_.option.md), [Set](classes/_codec_set_.set.md), [Struct](classes/_codec_struct_.struct.md), [Tuple](classes/_codec_tuple_.tuple.md), [U8a](classes/_codec_u8a_.u8a.md), [U8aFixed](classes/_codec_u8afixed_.u8afixed.md), [UInt](classes/_codec_uint_.uint.md), [Vector](classes/_codec_vector_.vector.md) - -RPC types ---------- - -These types are not used in the runtime, but rather are used in RPC results: [ChainProperties](classes/_rpc_chainproperties_.chainproperties.md), [ExtrinsicStatus](classes/_rpc_extrinsicstatus_.extrinsicstatus.md), [Health](classes/_rpc_health_.health.md), [Json](classes/_rpc_json_.json.md), [NetworkState](classes/_rpc_networkstate_.networkstate.md), [Metadata](classes/_metadata_metadata_.metadata.md), [PeerInfo](classes/_rpc_peerinfo_.peerinfo.md), [PendingExtrinsics](classes/_rpc_pendingextrinsics_.pendingextrinsics.md), [RuntimeVersion](classes/_rpc_runtimeversion_.runtimeversion.md), [SignedBlock](classes/_rpc_signedblock_.signedblock.md), [StorageChangeSet](classes/_rpc_storagechangeset_.storagechangeset.md) - -Derived types -------------- - -Some types are extended from the base to provide additional information: [HeaderExtended](classes/_type_header_.headerextended.md), \[\[ReferendumInfoExtended\]\] - diff --git a/docs/types/SUMMARY.html b/docs/types/SUMMARY.html deleted file mode 100644 index e2f334c107..0000000000 --- a/docs/types/SUMMARY.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api
- - - diff --git a/docs/types/SUMMARY.md b/docs/types/SUMMARY.md deleted file mode 100644 index 3614a622d1..0000000000 --- a/docs/types/SUMMARY.md +++ /dev/null @@ -1,315 +0,0 @@ -* ["Metadata/MagicNumber"](modules/_metadata_magicnumber_.md) - * [MagicNumber](classes/_metadata_magicnumber_.magicnumber.md) -* ["Metadata/Metadata"](modules/_metadata_metadata_.md) - * [Metadata](classes/_metadata_metadata_.metadata.md) -* ["Metadata/MetadataVersioned"](modules/_metadata_metadataversioned_.md) - * [MetadataVersioned](classes/_metadata_metadataversioned_.metadataversioned.md) -* ["Metadata/static"](modules/_metadata_static_.md) -* ["Metadata/types"](modules/_metadata_types_.md) - * [MetadataInterface](interfaces/_metadata_types_.metadatainterface.md) -* ["Metadata/util/flattenUniq"](modules/_metadata_util_flattenuniq_.md) -* ["Metadata/util/validateTypes"](modules/_metadata_util_validatetypes_.md) -* ["Metadata/v0/Calls"](modules/_metadata_v0_calls_.md) - * [OuterDispatchCall](classes/_metadata_v0_calls_.outerdispatchcall.md) - * [OuterDispatchMetadata](classes/_metadata_v0_calls_.outerdispatchmetadata.md) -* ["Metadata/v0/Events"](modules/_metadata_v0_events_.md) - * [EventMetadata](classes/_metadata_v0_events_.eventmetadata.md) - * [OuterEventMetadata](classes/_metadata_v0_events_.outereventmetadata.md) - * [OuterEventMetadataEvent](classes/_metadata_v0_events_.outereventmetadataevent.md) -* ["Metadata/v0/Metadata"](modules/_metadata_v0_metadata_.md) - * [MetadataV0](classes/_metadata_v0_metadata_.metadatav0.md) -* ["Metadata/v0/Modules"](modules/_metadata_v0_modules_.md) - * [CallMetadata](classes/_metadata_v0_modules_.callmetadata.md) - * [FunctionArgumentMetadata](classes/_metadata_v0_modules_.functionargumentmetadata.md) - * [FunctionMetadata](classes/_metadata_v0_modules_.functionmetadata.md) - * [MapType](classes/_metadata_v0_modules_.maptype.md) - * [ModuleMetadata](classes/_metadata_v0_modules_.modulemetadata.md) - * [RuntimeModuleMetadata](classes/_metadata_v0_modules_.runtimemodulemetadata.md) - * [StorageFunctionMetadata](classes/_metadata_v0_modules_.storagefunctionmetadata.md) - * [StorageFunctionModifier](classes/_metadata_v0_modules_.storagefunctionmodifier.md) - * [StorageFunctionType](classes/_metadata_v0_modules_.storagefunctiontype.md) - * [StorageMetadata](classes/_metadata_v0_modules_.storagemetadata.md) -* ["Metadata/v0/static"](modules/_metadata_v0_static_.md) -* ["Metadata/v1/Calls"](modules/_metadata_v1_calls_.md) - * [MetadataCall](classes/_metadata_v1_calls_.metadatacall.md) - * [MetadataCallArg](classes/_metadata_v1_calls_.metadatacallarg.md) -* ["Metadata/v1/Events"](modules/_metadata_v1_events_.md) - * [MetadataEvent](classes/_metadata_v1_events_.metadataevent.md) -* ["Metadata/v1/Metadata"](modules/_metadata_v1_metadata_.md) - * [MetadataModule](classes/_metadata_v1_metadata_.metadatamodule.md) - * [MetadataV1](classes/_metadata_v1_metadata_.metadatav1.md) -* ["Metadata/v1/Storage"](modules/_metadata_v1_storage_.md) - * [Default](classes/_metadata_v1_storage_.default.md) - * [MapType](classes/_metadata_v1_storage_.maptype.md) - * [MetadataStorage](classes/_metadata_v1_storage_.metadatastorage.md) - * [MetadataStorageModifier](classes/_metadata_v1_storage_.metadatastoragemodifier.md) - * [MetadataStorageType](classes/_metadata_v1_storage_.metadatastoragetype.md) - * [Optional](classes/_metadata_v1_storage_.optional.md) - * [PlainType](classes/_metadata_v1_storage_.plaintype.md) -* ["Metadata/v1/static"](modules/_metadata_v1_static_.md) -* ["Metadata/v1/toV0"](modules/_metadata_v1_tov0_.md) -* ["classes"](modules/_classes_.md) -* ["codec/AbstractInt"](modules/_codec_abstractint_.md) -* ["codec/Base"](modules/_codec_base_.md) - * [Base](classes/_codec_base_.base.md) -* ["codec/Compact"](modules/_codec_compact_.md) - * [Compact](classes/_codec_compact_.compact.md) -* ["codec/Enum"](modules/_codec_enum_.md) - * [Enum](classes/_codec_enum_.enum.md) -* ["codec/EnumType"](modules/_codec_enumtype_.md) - * [EnumType](classes/_codec_enumtype_.enumtype.md) -* ["codec/Int"](modules/_codec_int_.md) - * [Int](classes/_codec_int_.int.md) -* ["codec/Option"](modules/_codec_option_.md) - * [Option](classes/_codec_option_.option.md) -* ["codec/Set"](modules/_codec_set_.md) - * [Set](classes/_codec_set_.set.md) -* ["codec/Struct"](modules/_codec_struct_.md) - * [Struct](classes/_codec_struct_.struct.md) -* ["codec/Tuple"](modules/_codec_tuple_.md) - * [Tuple](classes/_codec_tuple_.tuple.md) -* ["codec/U8a"](modules/_codec_u8a_.md) - * [U8a](classes/_codec_u8a_.u8a.md) -* ["codec/U8aFixed"](modules/_codec_u8afixed_.md) - * [U8aFixed](classes/_codec_u8afixed_.u8afixed.md) -* ["codec/UInt"](modules/_codec_uint_.md) - * [UInt](classes/_codec_uint_.uint.md) -* ["codec/Vector"](modules/_codec_vector_.md) - * [Vector](classes/_codec_vector_.vector.md) -* ["codec/createType"](modules/_codec_createtype_.md) - * [TypeDefInfo](enums/_codec_createtype_.typedefinfo.md) -* ["codec/typeRegistry"](modules/_codec_typeregistry_.md) - * [TypeRegistry](classes/_codec_typeregistry_.typeregistry.md) -* ["codec/utils/compareArray"](modules/_codec_utils_comparearray_.md) -* ["codec/utils/compareMap"](modules/_codec_utils_comparemap_.md) -* ["codec/utils/decodeU8a"](modules/_codec_utils_decodeu8a_.md) -* ["index.types"](modules/_index_types_.md) -* ["primitive/Bool"](modules/_primitive_bool_.md) - * [Bool](classes/_primitive_bool_.bool.md) -* ["primitive/Bytes"](modules/_primitive_bytes_.md) - * [Bytes](classes/_primitive_bytes_.bytes.md) -* ["primitive/Data"](modules/_primitive_data_.md) - * [Data](classes/_primitive_data_.data.md) -* ["primitive/H160"](modules/_primitive_h160_.md) - * [H160](classes/_primitive_h160_.h160.md) -* ["primitive/H256"](modules/_primitive_h256_.md) - * [H256](classes/_primitive_h256_.h256.md) -* ["primitive/H512"](modules/_primitive_h512_.md) - * [H512](classes/_primitive_h512_.h512.md) -* ["primitive/I128"](modules/_primitive_i128_.md) - * [I128](classes/_primitive_i128_.i128.md) -* ["primitive/I16"](modules/_primitive_i16_.md) - * [I16](classes/_primitive_i16_.i16.md) -* ["primitive/I256"](modules/_primitive_i256_.md) - * [I256](classes/_primitive_i256_.i256.md) -* ["primitive/I32"](modules/_primitive_i32_.md) - * [I32](classes/_primitive_i32_.i32.md) -* ["primitive/I64"](modules/_primitive_i64_.md) - * [I64](classes/_primitive_i64_.i64.md) -* ["primitive/I8"](modules/_primitive_i8_.md) - * [I8](classes/_primitive_i8_.i8.md) -* ["primitive/Method"](modules/_primitive_method_.md) - * [Method](classes/_primitive_method_.method.md) - * [MethodIndex](classes/_primitive_method_.methodindex.md) - * [MethodFunction](interfaces/_primitive_method_.methodfunction.md) - * [Methods](interfaces/_primitive_method_.methods.md) - * [ModulesWithMethods](interfaces/_primitive_method_.moduleswithmethods.md) -* ["primitive/Moment"](modules/_primitive_moment_.md) - * [Moment](classes/_primitive_moment_.moment.md) - * [MomentOf](classes/_primitive_moment_.momentof.md) -* ["primitive/Null"](modules/_primitive_null_.md) - * [Null](classes/_primitive_null_.null.md) -* ["primitive/StorageData"](modules/_primitive_storagedata_.md) - * [StorageData](classes/_primitive_storagedata_.storagedata.md) -* ["primitive/StorageKey"](modules/_primitive_storagekey_.md) - * [StorageKey](classes/_primitive_storagekey_.storagekey.md) - * [StorageFunction](interfaces/_primitive_storagekey_.storagefunction.md) -* ["primitive/Text"](modules/_primitive_text_.md) - * [Text](classes/_primitive_text_.text.md) -* ["primitive/Type"](modules/_primitive_type_.md) - * [Type](classes/_primitive_type_.type.md) -* ["primitive/U128"](modules/_primitive_u128_.md) - * [U128](classes/_primitive_u128_.u128.md) -* ["primitive/U16"](modules/_primitive_u16_.md) - * [U16](classes/_primitive_u16_.u16.md) -* ["primitive/U256"](modules/_primitive_u256_.md) - * [U256](classes/_primitive_u256_.u256.md) -* ["primitive/U32"](modules/_primitive_u32_.md) - * [U32](classes/_primitive_u32_.u32.md) -* ["primitive/U64"](modules/_primitive_u64_.md) - * [U64](classes/_primitive_u64_.u64.md) -* ["primitive/U8"](modules/_primitive_u8_.md) - * [U8](classes/_primitive_u8_.u8.md) -* ["primitive/USize"](modules/_primitive_usize_.md) - * [USize](classes/_primitive_usize_.usize.md) -* ["rpc/ChainProperties"](modules/_rpc_chainproperties_.md) - * [ChainProperties](classes/_rpc_chainproperties_.chainproperties.md) -* ["rpc/ExtrinsicStatus"](modules/_rpc_extrinsicstatus_.md) - * [Broadcast](classes/_rpc_extrinsicstatus_.broadcast.md) - * [Dropped](classes/_rpc_extrinsicstatus_.dropped.md) - * [ExtrinsicStatus](classes/_rpc_extrinsicstatus_.extrinsicstatus.md) - * [Finalised](classes/_rpc_extrinsicstatus_.finalised.md) - * [Future](classes/_rpc_extrinsicstatus_.future.md) - * [Invalid](classes/_rpc_extrinsicstatus_.invalid.md) - * [Ready](classes/_rpc_extrinsicstatus_.ready.md) - * [Usurped](classes/_rpc_extrinsicstatus_.usurped.md) -* ["rpc/Health"](modules/_rpc_health_.md) - * [Health](classes/_rpc_health_.health.md) -* ["rpc/Json"](modules/_rpc_json_.md) - * [Json](classes/_rpc_json_.json.md) -* ["rpc/NetworkState"](modules/_rpc_networkstate_.md) - * [NetworkState](classes/_rpc_networkstate_.networkstate.md) -* ["rpc/PeerInfo"](modules/_rpc_peerinfo_.md) - * [PeerInfo](classes/_rpc_peerinfo_.peerinfo.md) -* ["rpc/PendingExtrinsics"](modules/_rpc_pendingextrinsics_.md) - * [PendingExtrinsics](classes/_rpc_pendingextrinsics_.pendingextrinsics.md) -* ["rpc/RuntimeVersion"](modules/_rpc_runtimeversion_.md) - * [ApiId](classes/_rpc_runtimeversion_.apiid.md) - * [RuntimeVersion](classes/_rpc_runtimeversion_.runtimeversion.md) - * [RuntimeVersionApi](classes/_rpc_runtimeversion_.runtimeversionapi.md) -* ["rpc/SignedBlock"](modules/_rpc_signedblock_.md) - * [SignedBlock](classes/_rpc_signedblock_.signedblock.md) -* ["rpc/StorageChangeSet"](modules/_rpc_storagechangeset_.md) - * [StorageChangeSet](classes/_rpc_storagechangeset_.storagechangeset.md) -* ["scripts/MetadataMd"](modules/_scripts_metadatamd_.md) -* ["type/AccountId"](modules/_type_accountid_.md) - * [AccountId](classes/_type_accountid_.accountid.md) - * [AccountIdOf](classes/_type_accountid_.accountidof.md) -* ["type/AccountIndex"](modules/_type_accountindex_.md) - * [AccountIndex](classes/_type_accountindex_.accountindex.md) -* ["type/Address"](modules/_type_address_.md) - * [Address](classes/_type_address_.address.md) -* ["type/Amount"](modules/_type_amount_.md) - * [Amount](classes/_type_amount_.amount.md) -* ["type/AssetOf"](modules/_type_assetof_.md) - * [AssetOf](classes/_type_assetof_.assetof.md) -* ["type/AttestedCandidate"](modules/_type_attestedcandidate_.md) - * [AttestedCandidate](classes/_type_attestedcandidate_.attestedcandidate.md) - * [AvailabilityVote](classes/_type_attestedcandidate_.availabilityvote.md) - * [BalanceUpload](classes/_type_attestedcandidate_.balanceupload.md) - * [CandidateReceipt](classes/_type_attestedcandidate_.candidatereceipt.md) - * [CandidateSignature](classes/_type_attestedcandidate_.candidatesignature.md) - * [EgressQueueRoot](classes/_type_attestedcandidate_.egressqueueroot.md) - * [ExplicitCandidateSignature](classes/_type_attestedcandidate_.explicitcandidatesignature.md) - * [HeadData](classes/_type_attestedcandidate_.headdata.md) - * [ImplicitCandidateSignature](classes/_type_attestedcandidate_.implicitcandidatesignature.md) - * [ValidityAttestation](classes/_type_attestedcandidate_.validityattestation.md) - * [ValidityVote](classes/_type_attestedcandidate_.validityvote.md) -* ["type/AuthorityId"](modules/_type_authorityid_.md) - * [AuthorityId](classes/_type_authorityid_.authorityid.md) -* ["type/Balance"](modules/_type_balance_.md) - * [Balance](classes/_type_balance_.balance.md) - * [BalanceOf](classes/_type_balance_.balanceof.md) -* ["type/Bft"](modules/_type_bft_.md) - * [BftAuthoritySignature](classes/_type_bft_.bftauthoritysignature.md) - * [BftHashSignature](classes/_type_bft_.bfthashsignature.md) -* ["type/Block"](modules/_type_block_.md) - * [Block](classes/_type_block_.block.md) -* ["type/BlockNumber"](modules/_type_blocknumber_.md) - * [BlockNumber](classes/_type_blocknumber_.blocknumber.md) -* ["type/CodeHash"](modules/_type_codehash_.md) - * [CodeHash](classes/_type_codehash_.codehash.md) -* ["type/Digest"](modules/_type_digest_.md) - * [AuthoritiesChange](classes/_type_digest_.authoritieschange.md) - * [ChangesTrieRoot](classes/_type_digest_.changestrieroot.md) - * [Digest](classes/_type_digest_.digest.md) - * [DigestItem](classes/_type_digest_.digestitem.md) - * [Other](classes/_type_digest_.other.md) - * [Seal](classes/_type_digest_.seal.md) -* ["type/Event"](modules/_type_event_.md) - * [Event](classes/_type_event_.event.md) - * [EventData](classes/_type_event_.eventdata.md) - * [EventIndex](classes/_type_event_.eventindex.md) -* ["type/EventRecord"](modules/_type_eventrecord_.md) - * [ApplyExtrinsic](classes/_type_eventrecord_.applyextrinsic.md) - * [EventRecord](classes/_type_eventrecord_.eventrecord.md) - * [Finalization](classes/_type_eventrecord_.finalization.md) - * [Phase](classes/_type_eventrecord_.phase.md) -* ["type/Extrinsic"](modules/_type_extrinsic_.md) - * [Extrinsic](classes/_type_extrinsic_.extrinsic.md) -* ["type/ExtrinsicEra"](modules/_type_extrinsicera_.md) - * [ExtrinsicEra](classes/_type_extrinsicera_.extrinsicera.md) -* ["type/ExtrinsicSignature"](modules/_type_extrinsicsignature_.md) - * [ExtrinsicSignature](classes/_type_extrinsicsignature_.extrinsicsignature.md) -* ["type/Extrinsics"](modules/_type_extrinsics_.md) - * [Extrinsics](classes/_type_extrinsics_.extrinsics.md) -* ["type/Gas"](modules/_type_gas_.md) - * [Gas](classes/_type_gas_.gas.md) -* ["type/Hash"](modules/_type_hash_.md) - * [Hash](classes/_type_hash_.hash.md) -* ["type/Header"](modules/_type_header_.md) - * [Header](classes/_type_header_.header.md) - * [HeaderExtended](classes/_type_header_.headerextended.md) -* ["type/InherentOfflineReport"](modules/_type_inherentofflinereport_.md) - * [InherentOfflineReport](classes/_type_inherentofflinereport_.inherentofflinereport.md) -* ["type/Justification"](modules/_type_justification_.md) - * [Justification](classes/_type_justification_.justification.md) - * [RhdJustification](classes/_type_justification_.rhdjustification.md) -* ["type/KeyValue"](modules/_type_keyvalue_.md) - * [KeyValue](classes/_type_keyvalue_.keyvalue.md) - * [KeyValueOption](classes/_type_keyvalue_.keyvalueoption.md) -* ["type/LockPeriods"](modules/_type_lockperiods_.md) - * [LocKPeriods](classes/_type_lockperiods_.lockperiods.md) -* ["type/MisbehaviorReport"](modules/_type_misbehaviorreport_.md) - * [BftAtReport](classes/_type_misbehaviorreport_.bftatreport.md) - * [BftDoubleCommit](classes/_type_misbehaviorreport_.bftdoublecommit.md) - * [BftDoublePrepare](classes/_type_misbehaviorreport_.bftdoubleprepare.md) - * [BftDoublePropose](classes/_type_misbehaviorreport_.bftdoublepropose.md) - * [BftProposeOutOfTurn](classes/_type_misbehaviorreport_.bftproposeoutofturn.md) - * [MisbehaviorKind](classes/_type_misbehaviorreport_.misbehaviorkind.md) - * [MisbehaviorReport](classes/_type_misbehaviorreport_.misbehaviorreport.md) -* ["type/NewAccountOutcome"](modules/_type_newaccountoutcome_.md) - * [NewAccountOutcome](classes/_type_newaccountoutcome_.newaccountoutcome.md) -* ["type/Nonce"](modules/_type_nonce_.md) - * [Nonce](classes/_type_nonce_.nonce.md) -* ["type/NonceCompact"](modules/_type_noncecompact_.md) - * [NonceCompact](classes/_type_noncecompact_.noncecompact.md) -* ["type/Origin"](modules/_type_origin_.md) - * [Origin](classes/_type_origin_.origin.md) -* ["type/ParaId"](modules/_type_paraid_.md) - * [ParaId](classes/_type_paraid_.paraid.md) -* ["type/Perbill"](modules/_type_perbill_.md) - * [Perbill](classes/_type_perbill_.perbill.md) -* ["type/Permill"](modules/_type_permill_.md) - * [Permill](classes/_type_permill_.permill.md) -* ["type/PrefabWasmModule"](modules/_type_prefabwasmmodule_.md) - * [PrefabWasmModule](classes/_type_prefabwasmmodule_.prefabwasmmodule.md) -* ["type/PropIndex"](modules/_type_propindex_.md) - * [PropIndex](classes/_type_propindex_.propindex.md) -* ["type/Proposal"](modules/_type_proposal_.md) - * [Proposal](classes/_type_proposal_.proposal.md) -* ["type/ProposalIndex"](modules/_type_proposalindex_.md) - * [ProposalIndex](classes/_type_proposalindex_.proposalindex.md) -* ["type/ReferendumIndex"](modules/_type_referendumindex_.md) - * [ReferendumIndex](classes/_type_referendumindex_.referendumindex.md) -* ["type/ReferendumInfo"](modules/_type_referenduminfo_.md) - * [ReferendumInfo](classes/_type_referenduminfo_.referenduminfo.md) -* ["type/Schedule"](modules/_type_schedule_.md) - * [Schedule](classes/_type_schedule_.schedule.md) -* ["type/SeedOf"](modules/_type_seedof_.md) - * [SeedOf](classes/_type_seedof_.seedof.md) -* ["type/SessionKey"](modules/_type_sessionkey_.md) - * [SessionKey](classes/_type_sessionkey_.sessionkey.md) -* ["type/Signature"](modules/_type_signature_.md) - * [Ed25519Signature](classes/_type_signature_.ed25519signature.md) - * [Signature](classes/_type_signature_.signature.md) - * [Sr25519Signature](classes/_type_signature_.sr25519signature.md) -* ["type/SignaturePayload"](modules/_type_signaturepayload_.md) - * [SignaturePayload](classes/_type_signaturepayload_.signaturepayload.md) -* ["type/StoredPendingChange"](modules/_type_storedpendingchange_.md) - * [NextAuthority](classes/_type_storedpendingchange_.nextauthority.md) - * [StoredPendingChange](classes/_type_storedpendingchange_.storedpendingchange.md) -* ["type/ValidatorPrefs"](modules/_type_validatorprefs_.md) - * [ValidatorPrefs](classes/_type_validatorprefs_.validatorprefs.md) -* ["type/VestingSchedule"](modules/_type_vestingschedule_.md) - * [VestingSchedule](classes/_type_vestingschedule_.vestingschedule.md) -* ["type/Vote"](modules/_type_vote_.md) - * [Vote](classes/_type_vote_.vote.md) -* ["type/VoteIndex"](modules/_type_voteindex_.md) - * [VoteIndex](classes/_type_voteindex_.voteindex.md) -* ["type/VoteThreshold"](modules/_type_votethreshold_.md) - * [VoteThreshold](classes/_type_votethreshold_.votethreshold.md) -* ["types"](modules/_types_.md) - * [Codec](interfaces/_types_.codec.md) - * [Constructor](interfaces/_types_.constructor.md) - * [RuntimeVersionInterface](interfaces/_types_.runtimeversioninterface.md) diff --git a/docs/types/classes/_codec_base_.base.html b/docs/types/classes/_codec_base_.base.html deleted file mode 100644 index beb6d4dcc6..0000000000 --- a/docs/types/classes/_codec_base_.base.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/classes/_codec_base_.base.md b/docs/types/classes/_codec_base_.base.md deleted file mode 100644 index 683beb96b0..0000000000 --- a/docs/types/classes/_codec_base_.base.md +++ /dev/null @@ -1,44 +0,0 @@ - - -*__name__*: Base - -*__description__*: A type extends the Base class, when it holds a value - -# Type parameters -#### T -# Hierarchy - -**Base** - -↳ [EnumType](_codec_enumtype_.enumtype.md) - -↳ [Compact](_codec_compact_.compact.md) - -↳ [Option](_codec_option_.option.md) - -↳ [Enum](_codec_enum_.enum.md) - -↳ [Address](_type_address_.address.md) - -↳ [Set](_codec_set_.set.md) - -# Constructors - - - -## constructor - -⊕ **new Base**(value?: *`any`*): [Base](_codec_base_.base.md) - -*Defined in [codec/Base.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Base.ts#L10)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [Base](_codec_base_.base.md) - -___ - diff --git a/docs/types/classes/_codec_compact_.compact.html b/docs/types/classes/_codec_compact_.compact.html deleted file mode 100644 index 76d403e315..0000000000 --- a/docs/types/classes/_codec_compact_.compact.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Compact

description: A compact length-encoding codec wrapper. It performs the same function as Length, however differs in that it uses a variable number of bytes to do the actual encoding. This is mostly used by other types to add length-prefixed encoding, or in the case of wrapped types, taking a number and making the compact representation thereof

Hierarchy

Base<UInt | Moment>

↳ Compact

↳ NonceCompact

Implements

Constructors

constructor

⊕ new Compact(Type: Constructor<UInt | Moment>, value?: Compact | AnyNumber): Compact

Overrides Base.constructor

Defined in codec/Compact.ts:23

Parameters:

Name Type Default value
Type Constructor<UInt | Moment> -
Default value value Compact | AnyNumber 0

Returns: Compact

Properties

<Static> addLengthPrefix

● addLengthPrefix: compactAddLength = compactAddLength

Defined in codec/Compact.ts:41

Prepend a Uint8Array with its compact length.

param: The Uint8Array to be prefixed

<Static> decodeU8a

● decodeU8a: compactFromU8a = compactFromU8a

Defined in codec/Compact.ts:42

<Static> encodeU8a

● encodeU8a: compactToU8a = compactToU8a

Defined in codec/Compact.ts:43

Accessors

encodedLength

get encodedLength(): number

Defined in codec/Compact.ts:72

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/Compact.ts:79

description: Checks if the value is an empty value

Returns: boolean

Methods

bitLength

▸ bitLength(): UIntBitLength

Defined in codec/Compact.ts:86

description: Returns the number of bits in the value

Returns: UIntBitLength

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/Compact.ts:93

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toBn

▸ toBn(): BN

Defined in codec/Compact.ts:104

description: Returns the BN representation of the number

Returns: BN

toHex

▸ toHex(): any

Implementation of Codec.toHex

Defined in codec/Compact.ts:111

description: Returns a hex string representation of the value

Returns: any

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/Compact.ts:118

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Defined in codec/Compact.ts:125

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Defined in codec/Compact.ts:132

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/Compact.ts:140

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unwrap

▸ unwrap(): UInt | Moment

Defined in codec/Compact.ts:147

description: Returns the embedded UInt or Moment value

Returns: UInt | Moment

<Static> decodeCompact

▸ decodeCompact(Type: Constructor<UInt | Moment>, value: Compact | AnyNumber): Moment | UInt

Defined in codec/Compact.ts:51

Parameters:

Name Type
Type Constructor<UInt | Moment>
value Compact | AnyNumber

Returns: Moment | UInt

<Static> stripLengthPrefix

▸ stripLengthPrefix(u8a: Uint8Array, bitLength?: UIntBitLength): Uint8Array

Defined in codec/Compact.ts:45

Parameters:

Name Type Default value
u8a Uint8Array -
Default value bitLength UIntBitLength DEFAULT_BITLENGTH

Returns: Uint8Array

<Static> with

▸ with(Type: Constructor<UInt | Moment>): Constructor<Compact>

Defined in codec/Compact.ts:28

Parameters:

Name Type
Type Constructor<UInt | Moment>

Returns: Constructor<Compact>

- - - diff --git a/docs/types/classes/_codec_compact_.compact.md b/docs/types/classes/_codec_compact_.compact.md deleted file mode 100644 index c851fbee86..0000000000 --- a/docs/types/classes/_codec_compact_.compact.md +++ /dev/null @@ -1,299 +0,0 @@ - - -*__name__*: Compact - -*__description__*: A compact length-encoding codec wrapper. It performs the same function as Length, however differs in that it uses a variable number of bytes to do the actual encoding. This is mostly used by other types to add length-prefixed encoding, or in the case of wrapped types, taking a number and making the compact representation thereof - -# Hierarchy - - [Base](_codec_base_.base.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)> - -**↳ Compact** - -↳ [NonceCompact](_type_noncecompact_.noncecompact.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Compact**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*, value?: *[Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber)*): [Compact](_codec_compact_.compact.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L23)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)> | - | -| `Default value` value | [Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber) | 0 | - -**Returns:** [Compact](_codec_compact_.compact.md) - -___ - -# Properties - - - -## `` addLengthPrefix - -**● addLengthPrefix**: *`compactAddLength`* = compactAddLength - -*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L41)* - -Prepend a Uint8Array with its compact length. - -*__param__*: The Uint8Array to be prefixed - -___ - - -## `` decodeU8a - -**● decodeU8a**: *`compactFromU8a`* = compactFromU8a - -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L42)* - -___ - - -## `` encodeU8a - -**● encodeU8a**: *`compactToU8a`* = compactToU8a - -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L43)* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L72)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L79)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L86)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L93)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L104)* - -*__description__*: Returns the BN representation of the number - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L111)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `any` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L118)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L125)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [codec/Compact.ts:132](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L132)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L140)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unwrap - -▸ **unwrap**(): [UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md) - -*Defined in [codec/Compact.ts:147](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L147)* - -*__description__*: Returns the embedded [UInt](_codec_uint_.uint.md) or [Moment](_primitive_moment_.moment.md) value - -**Returns:** [UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md) - -___ - - -## `` decodeCompact - -▸ **decodeCompact**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*, value: *[Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_primitive_moment_.moment.md) \| [UInt](_codec_uint_.uint.md) - -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L51)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)> | -| value | [Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Moment](_primitive_moment_.moment.md) \| [UInt](_codec_uint_.uint.md) - -___ - - -## `` stripLengthPrefix - -▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*): `Uint8Array` - -*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L45)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| u8a | `Uint8Array` | - | -| `Default value` bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | DEFAULT_BITLENGTH | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*): [Constructor](../interfaces/_types_.constructor.md)<[Compact](_codec_compact_.compact.md)> - -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L28)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)> | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Compact](_codec_compact_.compact.md)> - -___ - diff --git a/docs/types/classes/_codec_enum_.enum.html b/docs/types/classes/_codec_enum_.enum.html deleted file mode 100644 index 13a8521bb2..0000000000 --- a/docs/types/classes/_codec_enum_.enum.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Enum

description: A codec wrapper for an enum. Enums are encoded as a single byte, where the byte is a zero-indexed value. This class allows you to retrieve the value either by toNumber() exposing the actual raw index, or toString() returning a string representation (as provided as part of the constructor)

Hierarchy

Base<number>

↳ Enum

↳ StorageFunctionModifier

↳ NewAccountOutcome

↳ VoteThreshold

Implements

Constructors

constructor

⊕ new Enum(def: EnumDef, value?: Enum | Uint8Array | string | number): Enum

Overrides Base.constructor

Defined in codec/Enum.ts:29

Parameters:

Name Type Default value
def EnumDef -
Default value value Enum | Uint8Array | string | number 0

Returns: Enum

Accessors

encodedLength

get encodedLength(): number

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/Enum.ts:71

description: Checks if the value is an empty value (always false)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/Enum.ts:78

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/Enum.ts:91

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/Enum.ts:98

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Defined in codec/Enum.ts:105

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Defined in codec/Enum.ts:112

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/Enum.ts:120

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

Defined in codec/Enum.ts:47

Parameters:

Name Type
def EnumDef
value Enum | Uint8Array | string | number

Returns: number | undefined

- - - diff --git a/docs/types/classes/_codec_enum_.enum.md b/docs/types/classes/_codec_enum_.enum.md deleted file mode 100644 index 2d0c0815d7..0000000000 --- a/docs/types/classes/_codec_enum_.enum.md +++ /dev/null @@ -1,195 +0,0 @@ - - -*__name__*: Enum - -*__description__*: A codec wrapper for an enum. Enums are encoded as a single byte, where the byte is a zero-indexed value. This class allows you to retrieve the value either by `toNumber()` exposing the actual raw index, or `toString()` returning a string representation (as provided as part of the constructor) - -# Hierarchy - - [Base](_codec_base_.base.md)<`number`> - -**↳ Enum** - -↳ [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md) - -↳ [NewAccountOutcome](_type_newaccountoutcome_.newaccountoutcome.md) - -↳ [VoteThreshold](_type_votethreshold_.votethreshold.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Enum**(def: *`EnumDef`*, value?: *[Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number`*): [Enum](_codec_enum_.enum.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Enum.ts:29](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L29)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| def | `EnumDef` | - | -| `Default value` value | [Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number` | 0 | - -**Returns:** [Enum](_codec_enum_.enum.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71)* - -*__description__*: Checks if the value is an empty value (always false) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeEnum - -▸ **decodeEnum**(def: *`EnumDef`*, value: *[Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number`*): `number` \| `undefined` - -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| def | `EnumDef` | -| value | [Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number` | - -**Returns:** `number` \| `undefined` - -___ - diff --git a/docs/types/classes/_codec_enumtype_.enumtype.html b/docs/types/classes/_codec_enumtype_.enumtype.html deleted file mode 100644 index 86209dc42b..0000000000 --- a/docs/types/classes/_codec_enumtype_.enumtype.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: EnumType

description: This implements an enum, that based on the value wraps a different type. It is effectively an extension to enum where the value type is determined by the actual index.

Type parameters

T

Hierarchy

Base<Codec>

↳ EnumType

↳ StorageFunctionType

↳ MetadataStorageModifier

↳ MetadataStorageType

↳ ExtrinsicStatus

↳ DigestItem

↳ ValidityAttestation

↳ Phase

↳ MisbehaviorKind

Implements

Constructors

constructor

⊕ new EnumType(def: TypesDef, value?: any, index?: number | EnumType<T>): EnumType

Overrides Base.constructor

Defined in codec/EnumType.ts:35

Parameters:

Name Type
def TypesDef
Optional value any
Optional index number | EnumType<T>

Returns: EnumType

Accessors

encodedLength

get encodedLength(): number

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isNone

get isNone(): boolean

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_codec_enumtype_.enumtype.md b/docs/types/classes/_codec_enumtype_.enumtype.md deleted file mode 100644 index a191995190..0000000000 --- a/docs/types/classes/_codec_enumtype_.enumtype.md +++ /dev/null @@ -1,275 +0,0 @@ - - -*__name__*: EnumType - -*__description__*: This implements an enum, that based on the value wraps a different type. It is effectively an extension to enum where the value type is determined by the actual index. - -# Type parameters -#### T -# Hierarchy - - [Base](_codec_base_.base.md)<[Codec](../interfaces/_types_.codec.md)> - -**↳ EnumType** - -↳ [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) - -↳ [MetadataStorageModifier](_metadata_v1_storage_.metadatastoragemodifier.md) - -↳ [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) - -↳ [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) - -↳ [DigestItem](_type_digest_.digestitem.md) - -↳ [ValidityAttestation](_type_attestedcandidate_.validityattestation.md) - -↳ [Phase](_type_eventrecord_.phase.md) - -↳ [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new EnumType**(def: *`TypesDef`*, value?: *`any`*, index?: *`number` \| [EnumType](_codec_enumtype_.enumtype.md)<`T`>*): [EnumType](_codec_enumtype_.enumtype.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/EnumType.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L35)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| def | `TypesDef` | -| `Optional` value | `any` | -| `Optional` index | `number` \| [EnumType](_codec_enumtype_.enumtype.md)<`T`> | - -**Returns:** [EnumType](_codec_enumtype_.enumtype.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_codec_int_.int.html b/docs/types/classes/_codec_int_.int.html deleted file mode 100644 index 58946cd67c..0000000000 --- a/docs/types/classes/_codec_int_.int.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Int

description: A generic signed integer codec. For Substrate all numbers are LE encoded, this handles the encoding and decoding of those numbers. Upon construction the bitLength is provided and any additional use keeps the number to this length. This extends BN, so all methods available on a normal BN object is available here.

Hierarchy

AbstractInt

↳ Int

↳ I8

↳ I16

↳ I32

↳ I64

↳ I128

↳ I256

Implements

Constructors

constructor

⊕ new Int(value?: AnyNumber, bitLength?: UIntBitLength, isHexJson?: boolean): Int

Overrides AbstractInt.__constructor

Defined in codec/Int.ts:21

Parameters:

Name Type Default value
Default value value AnyNumber 0
Default value bitLength UIntBitLength DEFAULT_UINT_BITS
Default value isHexJson boolean true

Returns: Int

Methods

toHex

▸ toHex(): string

Implementation of Codec.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_codec_int_.int.md b/docs/types/classes/_codec_int_.int.md deleted file mode 100644 index 89bfa706fe..0000000000 --- a/docs/types/classes/_codec_int_.int.md +++ /dev/null @@ -1,95 +0,0 @@ - - -*__name__*: Int - -*__description__*: A generic signed integer codec. For Substrate all numbers are LE encoded, this handles the encoding and decoding of those numbers. Upon construction the bitLength is provided and any additional use keeps the number to this length. This extends `BN`, so all methods available on a normal `BN` object is available here. - -# Hierarchy - - `AbstractInt` - -**↳ Int** - -↳ [I8](_primitive_i8_.i8.md) - -↳ [I16](_primitive_i16_.i16.md) - -↳ [I32](_primitive_i32_.i32.md) - -↳ [I64](_primitive_i64_.i64.md) - -↳ [I128](_primitive_i128_.i128.md) - -↳ [I256](_primitive_i256_.i256.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Int**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isHexJson?: *`boolean`*): [Int](_codec_int_.int.md) - -*Overrides AbstractInt.__constructor* - -*Defined in [codec/Int.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L21)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyNumber](../modules/_types_.md#anynumber) | 0 | -| `Default value` bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | DEFAULT_UINT_BITS | -| `Default value` isHexJson | `boolean` | true | - -**Returns:** [Int](_codec_int_.int.md) - -___ - -# Methods - - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_option_.option.html b/docs/types/classes/_codec_option_.option.html deleted file mode 100644 index 63bba9cd9a..0000000000 --- a/docs/types/classes/_codec_option_.option.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Option

description: An Option is an optional field. Basically the first byte indicates that there is is value to follow. If the byte is 1 there is an actual value. So the Option implements that - decodes, checks for optionality and wraps the required structure with a value if/as required/found.

Type parameters

T : Codec

Hierarchy

Base<T>

↳ Option

Implements

Constructors

constructor

⊕ new Option(Type: Constructor, value?: any): Option

Overrides Base.constructor

Defined in codec/Option.ts:19

Parameters:

Name Type
Type Constructor
Optional value any

Returns: Option

Accessors

encodedLength

get encodedLength(): number

Defined in codec/Option.ts:56

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/Option.ts:64

description: Checks if the Option has no value

Returns: boolean

isNone

get isNone(): boolean

Defined in codec/Option.ts:71

description: Checks if the Option has no value

Returns: boolean

isSome

get isSome(): boolean

Defined in codec/Option.ts:78

description: Checks if the Option has a value

Returns: boolean

value

get value(): Codec

Defined in codec/Option.ts:85

description: The actual value for the Option

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/Option.ts:92

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/Option.ts:103

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/Option.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Defined in codec/Option.ts:117

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/Option.ts:125

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unwrap

▸ unwrap(): T

Defined in codec/Option.ts:143

description: Returns the value that the Option represents (if available), throws if null

Returns: T

unwrapOr

▸ unwrapOr<O>(defaultValue: O): T | O

Defined in codec/Option.ts:155

description: Returns the value that the Option represents (if available) or defaultValue if none

Type parameters:

O

Parameters:

Name Type Description
defaultValue O The value to return if the option isNone

Returns: T | O

<Static> decodeOption

▸ decodeOption<O>(Type: Constructor, value?: any): Codec

Defined in codec/Option.ts:26

Type parameters:

O

Parameters:

Name Type
Type Constructor
Optional value any

Returns: Codec

<Static> with

▸ with<O>(Type: Constructor): Constructor<Option<O>>

Defined in codec/Option.ts:45

Type parameters:

O : Codec

Parameters:

Name Type
Type Constructor

Returns: Constructor<Option<O>>

- - - diff --git a/docs/types/classes/_codec_option_.option.md b/docs/types/classes/_codec_option_.option.md deleted file mode 100644 index 47059d6134..0000000000 --- a/docs/types/classes/_codec_option_.option.md +++ /dev/null @@ -1,275 +0,0 @@ - - -*__name__*: Option - -*__description__*: An Option is an optional field. Basically the first byte indicates that there is is value to follow. If the byte is `1` there is an actual value. So the Option implements that - decodes, checks for optionality and wraps the required structure with a value if/as required/found. - -# Type parameters -#### T : [Codec](../interfaces/_types_.codec.md) -# Hierarchy - - [Base](_codec_base_.base.md)<`T`> - -**↳ Option** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Option**(Type: *[Constructor](../interfaces/_types_.constructor.md)*, value?: *`any`*): [Option](_codec_option_.option.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Option.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L19)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md) | -| `Optional` value | `any` | - -**Returns:** [Option](_codec_option_.option.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/Option.ts:56](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L56)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/Option.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L64)* - -*__description__*: Checks if the Option has no value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Defined in [codec/Option.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L71)* - -*__description__*: Checks if the Option has no value - -**Returns:** `boolean` - -___ - - -## isSome - -**get isSome**(): `boolean` - -*Defined in [codec/Option.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L78)* - -*__description__*: Checks if the Option has a value - -**Returns:** `boolean` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Defined in [codec/Option.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L85)* - -*__description__*: The actual value for the Option - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/Option.ts:92](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L92)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/Option.ts:103](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L103)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/Option.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [codec/Option.ts:117](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L117)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/Option.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L125)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unwrap - -▸ **unwrap**(): `T` - -*Defined in [codec/Option.ts:143](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L143)* - -*__description__*: Returns the value that the Option represents (if available), throws if null - -**Returns:** `T` - -___ - - -## unwrapOr - -▸ **unwrapOr**<`O`>(defaultValue: *`O`*): `T` \| `O` - -*Defined in [codec/Option.ts:155](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L155)* - -*__description__*: Returns the value that the Option represents (if available) or defaultValue if none - -**Type parameters:** - -#### O -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| defaultValue | `O` | The value to return if the option isNone | - -**Returns:** `T` \| `O` - -___ - - -## `` decodeOption - -▸ **decodeOption**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) - -*Defined in [codec/Option.ts:26](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L26)* - -**Type parameters:** - -#### O -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md) | -| `Optional` value | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## `` with - -▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)*): [Constructor](../interfaces/_types_.constructor.md)<[Option](_codec_option_.option.md)<`O`>> - -*Defined in [codec/Option.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Option.ts#L45)* - -**Type parameters:** - -#### O : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md) | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Option](_codec_option_.option.md)<`O`>> - -___ - diff --git a/docs/types/classes/_codec_set_.set.html b/docs/types/classes/_codec_set_.set.html deleted file mode 100644 index cf71e932d2..0000000000 --- a/docs/types/classes/_codec_set_.set.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Set

description: An Set is an array of string values, represented an an encoded type by a bitwise representation of the values.

Hierarchy

Base<Array<string>>

↳ Set

Implements

Constructors

constructor

⊕ new Set(setValues: SetValues, value?: Array<string> | Uint8Array | number): Set

Overrides Base.constructor

Defined in codec/Set.ts:23

Parameters:

Name Type
setValues SetValues
Optional value Array<string> | Uint8Array | number

Returns: Set

Accessors

encodedLength

get encodedLength(): number

Defined in codec/Set.ts:73

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/Set.ts:80

description: true is the Set contains no values

Returns: boolean

valueEncoded

get valueEncoded(): number

Defined in codec/Set.ts:94

description: The encoded value for the set members

Returns: number

values

get values(): Array<string>

Defined in codec/Set.ts:87

description: The actual set values as a Array

Returns: Array<string>

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/Set.ts:101

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/Set.ts:117

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/Set.ts:124

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Defined in codec/Set.ts:131

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/Set.ts:139

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeSet

▸ decodeSet(setValues: SetValues, value?: Array<string> | Uint8Array | number): Array<string>

Defined in codec/Set.ts:33

Parameters:

Name Type Default value
setValues SetValues -
Default value value Array<string> | Uint8Array | number 0

Returns: Array<string>

<Static> encodeSet

▸ encodeSet(setValues: SetValues, value: Array<string>): number

Defined in codec/Set.ts:64

Parameters:

Name Type
setValues SetValues
value Array<string>

Returns: number

- - - diff --git a/docs/types/classes/_codec_set_.set.md b/docs/types/classes/_codec_set_.set.md deleted file mode 100644 index 670d0a0680..0000000000 --- a/docs/types/classes/_codec_set_.set.md +++ /dev/null @@ -1,220 +0,0 @@ - - -*__name__*: Set - -*__description__*: An Set is an array of string values, represented an an encoded type by a bitwise representation of the values. - -# Hierarchy - - [Base](_codec_base_.base.md)<`Array`<`string`>> - -**↳ Set** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Set**(setValues: *`SetValues`*, value?: *`Array`<`string`> \| `Uint8Array` \| `number`*): [Set](_codec_set_.set.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Set.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L23)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| setValues | `SetValues` | -| `Optional` value | `Array`<`string`> \| `Uint8Array` \| `number` | - -**Returns:** [Set](_codec_set_.set.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/Set.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L73)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/Set.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L80)* - -*__description__*: true is the Set contains no values - -**Returns:** `boolean` - -___ - - -## valueEncoded - -**get valueEncoded**(): `number` - -*Defined in [codec/Set.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L94)* - -*__description__*: The encoded value for the set members - -**Returns:** `number` - -___ - - -## values - -**get values**(): `Array`<`string`> - -*Defined in [codec/Set.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L87)* - -*__description__*: The actual set values as a Array - -**Returns:** `Array`<`string`> - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/Set.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L101)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/Set.ts:117](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L117)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/Set.ts:124](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L124)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [codec/Set.ts:131](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L131)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/Set.ts:139](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L139)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeSet - -▸ **decodeSet**(setValues: *`SetValues`*, value?: *`Array`<`string`> \| `Uint8Array` \| `number`*): `Array`<`string`> - -*Defined in [codec/Set.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L33)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| setValues | `SetValues` | - | -| `Default value` value | `Array`<`string`> \| `Uint8Array` \| `number` | 0 | - -**Returns:** `Array`<`string`> - -___ - - -## `` encodeSet - -▸ **encodeSet**(setValues: *`SetValues`*, value: *`Array`<`string`>*): `number` - -*Defined in [codec/Set.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Set.ts#L64)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| setValues | `SetValues` | -| value | `Array`<`string`> | - -**Returns:** `number` - -___ - diff --git a/docs/types/classes/_codec_struct_.struct.html b/docs/types/classes/_codec_struct_.struct.html deleted file mode 100644 index db61a37272..0000000000 --- a/docs/types/classes/_codec_struct_.struct.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Struct

description: A Struct defines an Object with key/values - where the values are Codec values. It removes a lot of repetition from the actual coding, define a structure type, pass it the key/Codec values in the constructor and it manages the decoding. It is important that the constructor values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical, it needs to decoded in the specific defined order.

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

Map<keyof S, Codec>

↳ Struct

↳ OuterDispatchCall

↳ OuterDispatchMetadata

↳ EventMetadata

↳ OuterEventMetadata

↳ FunctionArgumentMetadata

↳ FunctionMetadata

↳ CallMetadata

↳ ModuleMetadata

↳ MapType

↳ StorageFunctionMetadata

↳ StorageMetadata

↳ RuntimeModuleMetadata

↳ MetadataV0

↳ MetadataCallArg

↳ MetadataCall

↳ MetadataEvent

↳ MapType

↳ MetadataStorage

↳ MetadataModule

↳ MetadataV1

↳ MetadataVersioned

↳ Method

↳ Health

↳ PeerInfo

↳ RuntimeVersion

↳ SignaturePayload

↳ ExtrinsicSignature

↳ Extrinsic

↳ Digest

↳ Header

↳ Block

↳ RhdJustification

↳ SignedBlock

↳ KeyValue

↳ StorageChangeSet

↳ CandidateReceipt

↳ AttestedCandidate

↳ Event

↳ EventRecord

↳ BftAtReport

↳ BftProposeOutOfTurn

↳ MisbehaviorReport

↳ PrefabWasmModule

↳ ReferendumInfo

↳ Schedule

↳ StoredPendingChange

↳ ValidatorPrefs

↳ VestingSchedule

Implements

Constructors

constructor

⊕ new Struct(Types: S, value?: V | Map<any, any> | Array<any>, jsonMap?: Map<keyof S, string>): Struct

Defined in codec/Struct.ts:31

Parameters:

Name Type Default value
Types S -
Default value value V | Map<any, any> | Array<any> {} as V
Default value jsonMap Map<keyof S, string> new Map()

Returns: Struct

Properties

<Static> Map

● Map: MapConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36

Accessors

Type

get Type(): E

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

get

▸ get(name: keyof S): Codec | undefined

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

toArray

▸ toArray(): Array<Codec>

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_codec_struct_.struct.md b/docs/types/classes/_codec_struct_.struct.md deleted file mode 100644 index 6ec8210ecb..0000000000 --- a/docs/types/classes/_codec_struct_.struct.md +++ /dev/null @@ -1,356 +0,0 @@ - - -*__name__*: Struct - -*__description__*: A Struct defines an Object with key/values - where the values are Codec values. It removes a lot of repetition from the actual coding, define a structure type, pass it the key/Codec values in the constructor and it manages the decoding. It is important that the constructor values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical, it needs to decoded in the specific defined order. - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - - `Map`<`keyof S`, [Codec](../interfaces/_types_.codec.md)> - -**↳ Struct** - -↳ [OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md) - -↳ [OuterDispatchMetadata](_metadata_v0_calls_.outerdispatchmetadata.md) - -↳ [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -↳ [OuterEventMetadata](_metadata_v0_events_.outereventmetadata.md) - -↳ [FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md) - -↳ [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -↳ [CallMetadata](_metadata_v0_modules_.callmetadata.md) - -↳ [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) - -↳ [MapType](_metadata_v0_modules_.maptype.md) - -↳ [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) - -↳ [StorageMetadata](_metadata_v0_modules_.storagemetadata.md) - -↳ [RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md) - -↳ [MetadataV0](_metadata_v0_metadata_.metadatav0.md) - -↳ [MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md) - -↳ [MetadataCall](_metadata_v1_calls_.metadatacall.md) - -↳ [MetadataEvent](_metadata_v1_events_.metadataevent.md) - -↳ [MapType](_metadata_v1_storage_.maptype.md) - -↳ [MetadataStorage](_metadata_v1_storage_.metadatastorage.md) - -↳ [MetadataModule](_metadata_v1_metadata_.metadatamodule.md) - -↳ [MetadataV1](_metadata_v1_metadata_.metadatav1.md) - -↳ [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md) - -↳ [Method](_primitive_method_.method.md) - -↳ [Health](_rpc_health_.health.md) - -↳ [PeerInfo](_rpc_peerinfo_.peerinfo.md) - -↳ [RuntimeVersion](_rpc_runtimeversion_.runtimeversion.md) - -↳ [SignaturePayload](_type_signaturepayload_.signaturepayload.md) - -↳ [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -↳ [Extrinsic](_type_extrinsic_.extrinsic.md) - -↳ [Digest](_type_digest_.digest.md) - -↳ [Header](_type_header_.header.md) - -↳ [Block](_type_block_.block.md) - -↳ [RhdJustification](_type_justification_.rhdjustification.md) - -↳ [SignedBlock](_rpc_signedblock_.signedblock.md) - -↳ [KeyValue](_type_keyvalue_.keyvalue.md) - -↳ [StorageChangeSet](_rpc_storagechangeset_.storagechangeset.md) - -↳ [CandidateReceipt](_type_attestedcandidate_.candidatereceipt.md) - -↳ [AttestedCandidate](_type_attestedcandidate_.attestedcandidate.md) - -↳ [Event](_type_event_.event.md) - -↳ [EventRecord](_type_eventrecord_.eventrecord.md) - -↳ [BftAtReport](_type_misbehaviorreport_.bftatreport.md) - -↳ [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) - -↳ [MisbehaviorReport](_type_misbehaviorreport_.misbehaviorreport.md) - -↳ [PrefabWasmModule](_type_prefabwasmmodule_.prefabwasmmodule.md) - -↳ [ReferendumInfo](_type_referenduminfo_.referenduminfo.md) - -↳ [Schedule](_type_schedule_.schedule.md) - -↳ [StoredPendingChange](_type_storedpendingchange_.storedpendingchange.md) - -↳ [ValidatorPrefs](_type_validatorprefs_.validatorprefs.md) - -↳ [VestingSchedule](_type_vestingschedule_.vestingschedule.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Struct**(Types: *`S`*, value?: *`V` \| `Map`<`any`, `any`> \| `Array`<`any`>*, jsonMap?: *`Map`<`keyof S`, `string`>*): [Struct](_codec_struct_.struct.md) - -*Defined in [codec/Struct.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L31)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Types | `S` | - | -| `Default value` value | `V` \| `Map`<`any`, `any`> \| `Array`<`any`> | {} as V | -| `Default value` jsonMap | `Map`<`keyof S`, `string`> | new Map() | - -**Returns:** [Struct](_codec_struct_.struct.md) - -___ - -# Properties - - - -## `` Map - -**● Map**: *`MapConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_codec_tuple_.tuple.html b/docs/types/classes/_codec_tuple_.tuple.html deleted file mode 100644 index 4a083b7ae3..0000000000 --- a/docs/types/classes/_codec_tuple_.tuple.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Tuple

description: A Tuple defines an anonymous fixed-length array, where each element has its own type. It extends the base JS Array object.

Hierarchy

Array<Codec>

↳ Tuple

↳ OuterEventMetadataEvent

↳ RuntimeVersionApi

↳ Seal

↳ BftAuthoritySignature

↳ BftHashSignature

↳ KeyValueOption

↳ BalanceUpload

↳ EgressQueueRoot

↳ AvailabilityVote

↳ ValidityVote

↳ EventData

↳ InherentOfflineReport

↳ NextAuthority

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new Tuple(Types: TupleConstructors, value: any): Tuple

Defined in codec/Tuple.ts:22

Parameters:

Name Type
Types TupleConstructors
value any

Returns: Tuple

Properties

<Static> Array

● Array: ArrayConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1368

Accessors

Types

get Types(): Array<string>

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

toArray

▸ toArray(): Array<Codec>

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_codec_tuple_.tuple.md b/docs/types/classes/_codec_tuple_.tuple.md deleted file mode 100644 index 8ce44581fb..0000000000 --- a/docs/types/classes/_codec_tuple_.tuple.md +++ /dev/null @@ -1,289 +0,0 @@ - - -*__name__*: Tuple - -*__description__*: A Tuple defines an anonymous fixed-length array, where each element has its own type. It extends the base JS `Array` object. - -# Hierarchy - - `Array`<[Codec](../interfaces/_types_.codec.md)> - -**↳ Tuple** - -↳ [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) - -↳ [RuntimeVersionApi](_rpc_runtimeversion_.runtimeversionapi.md) - -↳ [Seal](_type_digest_.seal.md) - -↳ [BftAuthoritySignature](_type_bft_.bftauthoritysignature.md) - -↳ [BftHashSignature](_type_bft_.bfthashsignature.md) - -↳ [KeyValueOption](_type_keyvalue_.keyvalueoption.md) - -↳ [BalanceUpload](_type_attestedcandidate_.balanceupload.md) - -↳ [EgressQueueRoot](_type_attestedcandidate_.egressqueueroot.md) - -↳ [AvailabilityVote](_type_attestedcandidate_.availabilityvote.md) - -↳ [ValidityVote](_type_attestedcandidate_.validityvote.md) - -↳ [EventData](_type_event_.eventdata.md) - -↳ [InherentOfflineReport](_type_inherentofflinereport_.inherentofflinereport.md) - -↳ [NextAuthority](_type_storedpendingchange_.nextauthority.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new Tuple**(Types: *`TupleConstructors`*, value: *`any`*): [Tuple](_codec_tuple_.tuple.md) - -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | -| value | `any` | - -**Returns:** [Tuple](_codec_tuple_.tuple.md) - -___ - -# Properties - - - -## `` Array - -**● Array**: *`ArrayConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1368* - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.html b/docs/types/classes/_codec_typeregistry_.typeregistry.html deleted file mode 100644 index 3f70596aa1..0000000000 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/classes/_codec_typeregistry_.typeregistry.md b/docs/types/classes/_codec_typeregistry_.typeregistry.md deleted file mode 100644 index 51dfa3df6d..0000000000 --- a/docs/types/classes/_codec_typeregistry_.typeregistry.md +++ /dev/null @@ -1,68 +0,0 @@ - - -# Hierarchy - -**TypeRegistry** - -# Properties - - - -## `` defaultRegistry - -**● defaultRegistry**: *[TypeRegistry](_codec_typeregistry_.typeregistry.md)* = new TypeRegistry() - -*Defined in [codec/typeRegistry.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L12)* - -___ - -# Methods - - - -## get - -▸ **get**(name: *`string`*): [Constructor](../interfaces/_types_.constructor.md) \| `undefined` - -*Defined in [codec/typeRegistry.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L47)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| name | `string` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md) \| `undefined` - -___ - - -## register - -▸ **register**(type: *[Constructor](../interfaces/_types_.constructor.md) \| [RegistryTypes](../modules/_types_.md#registrytypes)*): `void` - -▸ **register**(name: *`string`*, type: *[Constructor](../interfaces/_types_.constructor.md)*): `void` - -*Defined in [codec/typeRegistry.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | [Constructor](../interfaces/_types_.constructor.md) \| [RegistryTypes](../modules/_types_.md#registrytypes) | - -**Returns:** `void` - -*Defined in [codec/typeRegistry.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/typeRegistry.ts#L17)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| name | `string` | -| type | [Constructor](../interfaces/_types_.constructor.md) | - -**Returns:** `void` - -___ - diff --git a/docs/types/classes/_codec_u8a_.u8a.html b/docs/types/classes/_codec_u8a_.u8a.html deleted file mode 100644 index 0e29a92cc8..0000000000 --- a/docs/types/classes/_codec_u8a_.u8a.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U8a

description: A basic wrapper around Uint8Array, with no frills and no fuss. It does differ from other implementations wher it will consume the full Uint8Array as passed to it. As such it is meant to be subclassed where the wrapper takes care of the actual lengths instead of used directly.

Hierarchy

Uint8Array

↳ U8a

↳ Bytes

↳ Data

↳ U8aFixed

↳ ExtrinsicEra

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new U8a(value?: AnyU8a): U8a

Defined in codec/U8a.ts:18

Parameters:

Name Type
Optional value AnyU8a

Returns: U8a

Properties

<Static> Uint8Array

● Uint8Array: Uint8ArrayConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2227

Accessors

encodedLength

get encodedLength(): number

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_codec_u8a_.u8a.md b/docs/types/classes/_codec_u8a_.u8a.md deleted file mode 100644 index 641c14f9dd..0000000000 --- a/docs/types/classes/_codec_u8a_.u8a.md +++ /dev/null @@ -1,217 +0,0 @@ - - -*__name__*: U8a - -*__description__*: A basic wrapper around Uint8Array, with no frills and no fuss. It does differ from other implementations wher it will consume the full Uint8Array as passed to it. As such it is meant to be subclassed where the wrapper takes care of the actual lengths instead of used directly. - -# Hierarchy - - `Uint8Array` - -**↳ U8a** - -↳ [Bytes](_primitive_bytes_.bytes.md) - -↳ [Data](_primitive_data_.data.md) - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -↳ [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new U8a**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [U8a](_codec_u8a_.u8a.md) - -*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [U8a](_codec_u8a_.u8a.md) - -___ - -# Properties - - - -## `` Uint8Array - -**● Uint8Array**: *`Uint8ArrayConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2227* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.html b/docs/types/classes/_codec_u8afixed_.u8afixed.html deleted file mode 100644 index 6744306152..0000000000 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U8aFixed

description: A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant to be used directly, rather is should be subclassed with the specific lengths.

Hierarchy

↳ U8a

↳ U8aFixed

↳ H160

↳ H256

↳ H512

↳ MethodIndex

↳ AccountId

↳ ApiId

↳ EventIndex

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new U8aFixed(value?: AnyU8a, bitLength?: BitLength): U8aFixed

Overrides U8a.constructor

Defined in codec/U8aFixed.ts:19

Parameters:

Name Type Default value
Default value value AnyU8a new Uint8Array()
Default value bitLength BitLength 256

Returns: U8aFixed

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_codec_u8afixed_.u8afixed.md b/docs/types/classes/_codec_u8afixed_.u8afixed.md deleted file mode 100644 index 113605054e..0000000000 --- a/docs/types/classes/_codec_u8afixed_.u8afixed.md +++ /dev/null @@ -1,863 +0,0 @@ - - -*__name__*: U8aFixed - -*__description__*: A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant to be used directly, rather is should be subclassed with the specific lengths. - -# Hierarchy - -↳ [U8a](_codec_u8a_.u8a.md) - -**↳ U8aFixed** - -↳ [H160](_primitive_h160_.h160.md) - -↳ [H256](_primitive_h256_.h256.md) - -↳ [H512](_primitive_h512_.h512.md) - -↳ [MethodIndex](_primitive_method_.methodindex.md) - -↳ [AccountId](_type_accountid_.accountid.md) - -↳ [ApiId](_rpc_runtimeversion_.apiid.md) - -↳ [EventIndex](_type_event_.eventindex.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new U8aFixed**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*, bitLength?: *`BitLength`*): [U8aFixed](_codec_u8afixed_.u8afixed.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [codec/U8aFixed.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L19)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_.md#anyu8a) | new Uint8Array() | -| `Default value` bitLength | `BitLength` | 256 | - -**Returns:** [U8aFixed](_codec_u8afixed_.u8afixed.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_codec_uint_.uint.html b/docs/types/classes/_codec_uint_.uint.html deleted file mode 100644 index 8113e0ff5c..0000000000 --- a/docs/types/classes/_codec_uint_.uint.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: UInt

description: A generic unsigned integer codec. For Substrate all numbers are LE encoded, this handles the encoding and decoding of those numbers. Upon construction the bitLength is provided and any additional use keeps the number to this length. This extends BN, so all methods available on a normal BN object is available here.

Hierarchy

AbstractInt

↳ UInt

↳ U32

↳ U16

↳ U8

↳ U64

↳ U128

↳ U256

Implements

Constructors

constructor

⊕ new UInt(value?: AnyNumber, bitLength?: UIntBitLength, isHexJson?: boolean): UInt

Overrides AbstractInt.__constructor

Defined in codec/UInt.ts:21

Parameters:

Name Type Default value
Default value value AnyNumber 0
Default value bitLength UIntBitLength DEFAULT_UINT_BITS
Default value isHexJson boolean false

Returns: UInt

Methods

toHex

▸ toHex(): string

Implementation of Codec.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_codec_uint_.uint.md b/docs/types/classes/_codec_uint_.uint.md deleted file mode 100644 index 7c9c8a0aaf..0000000000 --- a/docs/types/classes/_codec_uint_.uint.md +++ /dev/null @@ -1,95 +0,0 @@ - - -*__name__*: UInt - -*__description__*: A generic unsigned integer codec. For Substrate all numbers are LE encoded, this handles the encoding and decoding of those numbers. Upon construction the bitLength is provided and any additional use keeps the number to this length. This extends `BN`, so all methods available on a normal `BN` object is available here. - -# Hierarchy - - `AbstractInt` - -**↳ UInt** - -↳ [U32](_primitive_u32_.u32.md) - -↳ [U16](_primitive_u16_.u16.md) - -↳ [U8](_primitive_u8_.u8.md) - -↳ [U64](_primitive_u64_.u64.md) - -↳ [U128](_primitive_u128_.u128.md) - -↳ [U256](_primitive_u256_.u256.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new UInt**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isHexJson?: *`boolean`*): [UInt](_codec_uint_.uint.md) - -*Overrides AbstractInt.__constructor* - -*Defined in [codec/UInt.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L21)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyNumber](../modules/_types_.md#anynumber) | 0 | -| `Default value` bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | DEFAULT_UINT_BITS | -| `Default value` isHexJson | `boolean` | false | - -**Returns:** [UInt](_codec_uint_.uint.md) - -___ - -# Methods - - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_codec_vector_.vector.html b/docs/types/classes/_codec_vector_.vector.html deleted file mode 100644 index 77a631a9ee..0000000000 --- a/docs/types/classes/_codec_vector_.vector.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Vector

description: This manages codec arrays. Internally it keeps track of the length (as decoded) and allows construction with the passed Type in the constructor. It is an extension to Array, providing specific encoding/decoding on top of the base type.

Type parameters

T : Codec

Hierarchy

Array<T>

↳ Vector

↳ Broadcast

↳ Extrinsics

↳ AuthoritiesChange

Implements

Indexable

[n: number]: T

Constructors

constructor

⊕ new Vector(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Vector

Defined in codec/Vector.ts:22

Parameters:

Name Type Default value
Type Constructor<T> -
Default value value Vector<any> | Uint8Array | string | Array<any> [] as Array<any>

Returns: Vector

Properties

<Static> Array

● Array: ArrayConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1368

Accessors

Type

get Type(): string

Defined in codec/Vector.ts:66

description: The type for the items

Returns: string

encodedLength

get encodedLength(): number

Defined in codec/Vector.ts:73

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in codec/Vector.ts:59

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Overrides Array.length

Defined in codec/Vector.ts:82

description: The length of the value

Returns: number

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in codec/Vector.ts:90

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

filter

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Overrides Array.filter

Defined in codec/Vector.ts:173

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<T>

indexOf

▸ indexOf(_other?: any): number

Overrides Array.indexOf

Defined in codec/Vector.ts:97

description: Finds the index of the value in the array

Parameters:

Name Type
Optional _other any

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Overrides Array.map

Defined in codec/Vector.ts:182

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

toArray

▸ toArray(): Array<T>

Defined in codec/Vector.ts:115

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in codec/Vector.ts:122

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in codec/Vector.ts:129

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Overrides Array.toString

Defined in codec/Vector.ts:138

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in codec/Vector.ts:151

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

Name Type
Type Constructor<T>
value Vector<any> | Uint8Array | string | Array<any>

Returns: Array<T>

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

Name Type
Type Constructor<O>

Returns: Constructor<Vector<O>>

- - - diff --git a/docs/types/classes/_codec_vector_.vector.md b/docs/types/classes/_codec_vector_.vector.md deleted file mode 100644 index 0b087cc0a2..0000000000 --- a/docs/types/classes/_codec_vector_.vector.md +++ /dev/null @@ -1,331 +0,0 @@ - - -*__name__*: Vector - -*__description__*: This manages codec arrays. Internally it keeps track of the length (as decoded) and allows construction with the passed `Type` in the constructor. It is an extension to Array, providing specific encoding/decoding on top of the base type. - -# Type parameters -#### T : [Codec](../interfaces/_types_.codec.md) -# Hierarchy - - `Array`<`T`> - -**↳ Vector** - -↳ [Broadcast](_rpc_extrinsicstatus_.broadcast.md) - -↳ [Extrinsics](_type_extrinsics_.extrinsics.md) - -↳ [AuthoritiesChange](_type_digest_.authoritieschange.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: `T` -# Constructors - - - -## constructor - -⊕ **new Vector**(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): [Vector](_codec_vector_.vector.md) - -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | [] as Array<any> | - -**Returns:** [Vector](_codec_vector_.vector.md) - -___ - -# Properties - - - -## `` Array - -**● Array**: *`ArrayConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1368* - -___ - -# Accessors - - - -## Type - -**get Type**(): `string` - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66)* - -*__description__*: The type for the items - -**Returns:** `string` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Overrides Array.length* - -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`T`> - -*Overrides Array.filter* - -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<`T`> - -___ - - -## indexOf - -▸ **indexOf**(_other?: *`any`*): `number` - -*Overrides Array.indexOf* - -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97)* - -*__description__*: Finds the index of the value in the array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` _other | `any` | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Overrides Array.map* - -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## toArray - -▸ **toArray**(): `Array`<`T`> - -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`T`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeVector - -▸ **decodeVector**<`T`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): `Array`<`T`> - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### T : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | - -**Returns:** `Array`<`T`> - -___ - - -## `` with - -▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`O`>*): [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48)* - -**Type parameters:** - -#### O : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`O`> | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -___ - diff --git a/docs/types/classes/_metadata_magicnumber_.magicnumber.html b/docs/types/classes/_metadata_magicnumber_.magicnumber.html deleted file mode 100644 index 9eaa6b4179..0000000000 --- a/docs/types/classes/_metadata_magicnumber_.magicnumber.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ U32

↳ MagicNumber

Implements

Constructors

constructor

⊕ new MagicNumber(value?: any): MagicNumber

Overrides U32.constructor

Defined in Metadata/MagicNumber.ts:11

Parameters:

Name Type
Optional value any

Returns: MagicNumber

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_metadata_magicnumber_.magicnumber.md b/docs/types/classes/_metadata_magicnumber_.magicnumber.md deleted file mode 100644 index 681eac3dfd..0000000000 --- a/docs/types/classes/_metadata_magicnumber_.magicnumber.md +++ /dev/null @@ -1,2022 +0,0 @@ - - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ MagicNumber** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MagicNumber**(value?: *`any`*): [MagicNumber](_metadata_magicnumber_.magicnumber.md) - -*Overrides [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Defined in [Metadata/MagicNumber.ts:11](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MagicNumber.ts#L11)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MagicNumber](_metadata_magicnumber_.magicnumber.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_metadata_metadata_.metadata.html b/docs/types/classes/_metadata_metadata_.metadata.html deleted file mode 100644 index a2b89cb315..0000000000 --- a/docs/types/classes/_metadata_metadata_.metadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Metadata

description: The versioned runtime metadata as a decoded structure

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ MetadataVersioned

↳ Metadata

Implements

Constructors

constructor

⊕ new Metadata(value?: Uint8Array | string): Metadata

Overrides MetadataVersioned.constructor

Defined in Metadata/Metadata.ts:15

Parameters:

Name Type
Optional value Uint8Array | string

Returns: Metadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

asV0

get asV0(): MetadataV0

Inherited from MetadataVersioned.asV0

Defined in Metadata/MetadataVersioned.ts:86

description: Returns the wrapped metadata as a V0 object

Returns: MetadataV0

asV1

get asV1(): MetadataV1

Inherited from MetadataVersioned.asV1

Defined in Metadata/MetadataVersioned.ts:103

description: Returns the wrapped values as a V1 object

Returns: MetadataV1

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

magicNumber

get magicNumber(): MagicNumber

Inherited from MetadataVersioned.magicNumber

Defined in Metadata/MetadataVersioned.ts:65

description:

Returns: MagicNumber

version

get version(): number

Inherited from MetadataVersioned.version

Defined in Metadata/MetadataVersioned.ts:79

description: the metadata version this structure represents

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

getUniqTypes

▸ getUniqTypes(throwError: boolean): Array<string>

Implementation of MetadataInterface.getUniqTypes

Inherited from MetadataVersioned.getUniqTypes

Defined in Metadata/MetadataVersioned.ts:109

Parameters:

Name Type
throwError boolean

Returns: Array<string>

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_metadata_.metadata.md b/docs/types/classes/_metadata_metadata_.metadata.md deleted file mode 100644 index 546bb4b40c..0000000000 --- a/docs/types/classes/_metadata_metadata_.metadata.md +++ /dev/null @@ -1,530 +0,0 @@ - - -*__name__*: Metadata - -*__description__*: The versioned runtime metadata as a decoded structure - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md) - -**↳ Metadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) -* [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md) - -# Constructors - - - -## constructor - -⊕ **new Metadata**(value?: *`Uint8Array` \| `string`*): [Metadata](_metadata_metadata_.metadata.md) - -*Overrides [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[constructor](_metadata_metadataversioned_.metadataversioned.md#constructor)* - -*Defined in [Metadata/Metadata.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/Metadata.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `Uint8Array` \| `string` | - -**Returns:** [Metadata](_metadata_metadata_.metadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## asV0 - -**get asV0**(): [MetadataV0](_metadata_v0_metadata_.metadatav0.md) - -*Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[asV0](_metadata_metadataversioned_.metadataversioned.md#asv0)* - -*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L86)* - -*__description__*: Returns the wrapped metadata as a V0 object - -**Returns:** [MetadataV0](_metadata_v0_metadata_.metadatav0.md) - -___ - - -## asV1 - -**get asV1**(): [MetadataV1](_metadata_v1_metadata_.metadatav1.md) - -*Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[asV1](_metadata_metadataversioned_.metadataversioned.md#asv1)* - -*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L103)* - -*__description__*: Returns the wrapped values as a V1 object - -**Returns:** [MetadataV1](_metadata_v1_metadata_.metadatav1.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## magicNumber - -**get magicNumber**(): [MagicNumber](_metadata_magicnumber_.magicnumber.md) - -*Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[magicNumber](_metadata_metadataversioned_.metadataversioned.md#magicnumber)* - -*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L65)* - -*__description__*: - -**Returns:** [MagicNumber](_metadata_magicnumber_.magicnumber.md) - -___ - - -## version - -**get version**(): `number` - -*Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[version](_metadata_metadataversioned_.metadataversioned.md#version)* - -*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L79)* - -*__description__*: the metadata version this structure represents - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## getUniqTypes - -▸ **getUniqTypes**(throwError: *`boolean`*): `Array`<`string`> - -*Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* - -*Inherited from [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md).[getUniqTypes](_metadata_metadataversioned_.metadataversioned.md#getuniqtypes)* - -*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L109)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| throwError | `boolean` | - -**Returns:** `Array`<`string`> - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.html b/docs/types/classes/_metadata_metadataversioned_.metadataversioned.html deleted file mode 100644 index 57f08e24e0..0000000000 --- a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MetadataVersioned

description: The versioned runtime metadata as a decoded structure

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataVersioned

↳ Metadata

Implements

Constructors

constructor

⊕ new MetadataVersioned(value?: any): MetadataVersioned

Overrides Struct.constructor

Defined in Metadata/MetadataVersioned.ts:53

Parameters:

Name Type
Optional value any

Returns: MetadataVersioned

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

asV0

get asV0(): MetadataV0

Defined in Metadata/MetadataVersioned.ts:86

description: Returns the wrapped metadata as a V0 object

Returns: MetadataV0

asV1

get asV1(): MetadataV1

Defined in Metadata/MetadataVersioned.ts:103

description: Returns the wrapped values as a V1 object

Returns: MetadataV1

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

magicNumber

get magicNumber(): MagicNumber

Defined in Metadata/MetadataVersioned.ts:65

description:

Returns: MagicNumber

version

get version(): number

Defined in Metadata/MetadataVersioned.ts:79

description: the metadata version this structure represents

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

getUniqTypes

▸ getUniqTypes(throwError: boolean): Array<string>

Implementation of MetadataInterface.getUniqTypes

Defined in Metadata/MetadataVersioned.ts:109

Parameters:

Name Type
throwError boolean

Returns: Array<string>

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md b/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md deleted file mode 100644 index 0bd8dfc59f..0000000000 --- a/docs/types/classes/_metadata_metadataversioned_.metadataversioned.md +++ /dev/null @@ -1,522 +0,0 @@ - - -*__name__*: MetadataVersioned - -*__description__*: The versioned runtime metadata as a decoded structure - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataVersioned** - -↳ [Metadata](_metadata_metadata_.metadata.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) -* [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataVersioned**(value?: *`any`*): [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/MetadataVersioned.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L53)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataVersioned](_metadata_metadataversioned_.metadataversioned.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## asV0 - -**get asV0**(): [MetadataV0](_metadata_v0_metadata_.metadatav0.md) - -*Defined in [Metadata/MetadataVersioned.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L86)* - -*__description__*: Returns the wrapped metadata as a V0 object - -**Returns:** [MetadataV0](_metadata_v0_metadata_.metadatav0.md) - -___ - - -## asV1 - -**get asV1**(): [MetadataV1](_metadata_v1_metadata_.metadatav1.md) - -*Defined in [Metadata/MetadataVersioned.ts:103](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L103)* - -*__description__*: Returns the wrapped values as a V1 object - -**Returns:** [MetadataV1](_metadata_v1_metadata_.metadatav1.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## magicNumber - -**get magicNumber**(): [MagicNumber](_metadata_magicnumber_.magicnumber.md) - -*Defined in [Metadata/MetadataVersioned.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L65)* - -*__description__*: - -**Returns:** [MagicNumber](_metadata_magicnumber_.magicnumber.md) - -___ - - -## version - -**get version**(): `number` - -*Defined in [Metadata/MetadataVersioned.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L79)* - -*__description__*: the metadata version this structure represents - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## getUniqTypes - -▸ **getUniqTypes**(throwError: *`boolean`*): `Array`<`string`> - -*Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* - -*Defined in [Metadata/MetadataVersioned.ts:109](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MetadataVersioned.ts#L109)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| throwError | `boolean` | - -**Returns:** `Array`<`string`> - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.html b/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.html deleted file mode 100644 index ef396dc8ac..0000000000 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ OuterDispatchCall

Implements

Constructors

constructor

⊕ new OuterDispatchCall(value?: any): OuterDispatchCall

Overrides Struct.constructor

Defined in Metadata/v0/Calls.ts:10

Parameters:

Name Type
Optional value any

Returns: OuterDispatchCall

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): U16

Defined in Metadata/v0/Calls.ts:22

description: The U16 index for the call

Returns: U16

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Calls.ts:29

description: The name for the call

Returns: Text

prefix

get prefix(): Text

Defined in Metadata/v0/Calls.ts:36

description: The call prefix (or section)

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md b/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md deleted file mode 100644 index 8e7317391c..0000000000 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchcall.md +++ /dev/null @@ -1,483 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ OuterDispatchCall** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new OuterDispatchCall**(value?: *`any`*): [OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Calls.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L10)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): [U16](_primitive_u16_.u16.md) - -*Defined in [Metadata/v0/Calls.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L22)* - -*__description__*: The [U16](_primitive_u16_.u16.md) index for the call - -**Returns:** [U16](_primitive_u16_.u16.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Calls.ts:29](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L29)* - -*__description__*: The name for the call - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## prefix - -**get prefix**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Calls.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L36)* - -*__description__*: The call prefix (or section) - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html b/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html deleted file mode 100644 index 6667408a4e..0000000000 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ OuterDispatchMetadata

Implements

Constructors

constructor

⊕ new OuterDispatchMetadata(value?: any): OuterDispatchMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Calls.ts:41

Parameters:

Name Type
Optional value any

Returns: OuterDispatchMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

calls

get calls(): Vector<OuterDispatchCall>

Defined in Metadata/v0/Calls.ts:52

description: The [[OuterDispathCall]] wrapped

Returns: Vector<OuterDispatchCall>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Calls.ts:59

description: The name for the dispatch

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md b/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md deleted file mode 100644 index 6648efaa3e..0000000000 --- a/docs/types/classes/_metadata_v0_calls_.outerdispatchmetadata.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ OuterDispatchMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new OuterDispatchMetadata**(value?: *`any`*): [OuterDispatchMetadata](_metadata_v0_calls_.outerdispatchmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Calls.ts:41](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L41)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [OuterDispatchMetadata](_metadata_v0_calls_.outerdispatchmetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## calls - -**get calls**(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> - -*Defined in [Metadata/v0/Calls.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L52)* - -*__description__*: The \[\[OuterDispathCall\]\] wrapped - -**Returns:** [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Calls.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Calls.ts#L59)* - -*__description__*: The name for the dispatch - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_events_.eventmetadata.html b/docs/types/classes/_metadata_v0_events_.eventmetadata.html deleted file mode 100644 index 7bc5e14303..0000000000 --- a/docs/types/classes/_metadata_v0_events_.eventmetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ EventMetadata

Implements

Constructors

constructor

⊕ new EventMetadata(value?: any): EventMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Events.ts:11

Parameters:

Name Type
Optional value any

Returns: EventMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

arguments

get arguments(): Vector<Type>

Defined in Metadata/v0/Events.ts:23

description: The arguments of Type

Returns: Vector<Type>

documentation

get documentation(): Vector<Text>

Defined in Metadata/v0/Events.ts:30

description: The Text documentation

Returns: Vector<Text>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Events.ts:37

description: The name for the event

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_events_.eventmetadata.md b/docs/types/classes/_metadata_v0_events_.eventmetadata.md deleted file mode 100644 index d9ac5917e6..0000000000 --- a/docs/types/classes/_metadata_v0_events_.eventmetadata.md +++ /dev/null @@ -1,483 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ EventMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new EventMetadata**(value?: *`any`*): [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Events.ts:11](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L11)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## arguments - -**get arguments**(): [Vector](_codec_vector_.vector.md)<[Type](_primitive_type_.type.md)> - -*Defined in [Metadata/v0/Events.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L23)* - -*__description__*: The arguments of [Type](_metadata_v0_events_.eventmetadata.md#type) - -**Returns:** [Vector](_codec_vector_.vector.md)<[Type](_primitive_type_.type.md)> - -___ - - -## documentation - -**get documentation**(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -*Defined in [Metadata/v0/Events.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L30)* - -*__description__*: The [Text](_primitive_text_.text.md) documentation - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Events.ts:37](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L37)* - -*__description__*: The name for the event - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadata.html b/docs/types/classes/_metadata_v0_events_.outereventmetadata.html deleted file mode 100644 index e700454565..0000000000 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ OuterEventMetadata

Implements

Constructors

constructor

⊕ new OuterEventMetadata(value?: any): OuterEventMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Events.ts:65

Parameters:

Name Type
Optional value any

Returns: OuterEventMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

events

get events(): Vector<OuterEventMetadataEvent>

Defined in Metadata/v0/Events.ts:76

description: The OuterEventMetadataEvent

Returns: Vector<OuterEventMetadataEvent>

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Events.ts:83

description: The name of the event

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadata.md b/docs/types/classes/_metadata_v0_events_.outereventmetadata.md deleted file mode 100644 index 448b52d18e..0000000000 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadata.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ OuterEventMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new OuterEventMetadata**(value?: *`any`*): [OuterEventMetadata](_metadata_v0_events_.outereventmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Events.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L65)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [OuterEventMetadata](_metadata_v0_events_.outereventmetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## events - -**get events**(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> - -*Defined in [Metadata/v0/Events.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L76)* - -*__description__*: The [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Events.ts:83](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L83)* - -*__description__*: The name of the event - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.html b/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.html deleted file mode 100644 index 396d644ba1..0000000000 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Tuple

↳ OuterEventMetadataEvent

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new OuterEventMetadataEvent(value?: any): OuterEventMetadataEvent

Overrides Tuple.constructor

Defined in Metadata/v0/Events.ts:42

Parameters:

Name Type
Optional value any

Returns: OuterEventMetadataEvent

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

events

get events(): Vector<EventMetadata>

Defined in Metadata/v0/Events.ts:53

description: The EventMetadata

Returns: Vector<EventMetadata>

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Events.ts:60

description: The name of the section

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md b/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md deleted file mode 100644 index ea829c0212..0000000000 --- a/docs/types/classes/_metadata_v0_events_.outereventmetadataevent.md +++ /dev/null @@ -1,1194 +0,0 @@ - - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ OuterEventMetadataEvent** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new OuterEventMetadataEvent**(value?: *`any`*): [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [Metadata/v0/Events.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L42)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## events - -**get events**(): [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_v0_events_.eventmetadata.md)> - -*Defined in [Metadata/v0/Events.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L53)* - -*__description__*: The [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[EventMetadata](_metadata_v0_events_.eventmetadata.md)> - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Events.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Events.ts#L60)* - -*__description__*: The name of the section - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_metadata_v0_metadata_.metadatav0.html b/docs/types/classes/_metadata_v0_metadata_.metadatav0.html deleted file mode 100644 index 65f9845764..0000000000 --- a/docs/types/classes/_metadata_v0_metadata_.metadatav0.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MetadataV0

description: The runtime metadata as a decoded structure

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataV0

Implements

Constructors

constructor

⊕ new MetadataV0(value?: any): MetadataV0

Overrides Struct.constructor

Defined in Metadata/v0/Metadata.ts:26

Parameters:

Name Type
Optional value any

Returns: MetadataV0

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

calls

get calls(): Vector<OuterDispatchCall>

Defined in Metadata/v0/Metadata.ts:60

description: Wrapped OuterDispatchCall

Returns: Vector<OuterDispatchCall>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

events

get events(): Vector<OuterEventMetadataEvent>

Defined in Metadata/v0/Metadata.ts:67

description: Wrapped OuterEventMetadataEvent

Returns: Vector<OuterEventMetadataEvent>

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

modules

get modules(): Vector<RuntimeModuleMetadata>

Defined in Metadata/v0/Metadata.ts:74

description: Wrapped RuntimeModuleMetadata

Returns: Vector<RuntimeModuleMetadata>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

getUniqTypes

▸ getUniqTypes(throwError: boolean): Array<string>

Implementation of MetadataInterface.getUniqTypes

Defined in Metadata/v0/Metadata.ts:109

description: Helper to retrieve a list of all type that are found, sorted and de-deuplicated

Parameters:

Name Type
throwError boolean

Returns: Array<string>

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> decodeMetadata

▸ decodeMetadata(value: string | Uint8Array | object): object | Uint8Array

Defined in Metadata/v0/Metadata.ts:35

Parameters:

Name Type
value string | Uint8Array | object

Returns: object | Uint8Array

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_metadata_.metadatav0.md b/docs/types/classes/_metadata_v0_metadata_.metadatav0.md deleted file mode 100644 index 3480251227..0000000000 --- a/docs/types/classes/_metadata_v0_metadata_.metadatav0.md +++ /dev/null @@ -1,526 +0,0 @@ - - -*__name__*: MetadataV0 - -*__description__*: The runtime metadata as a decoded structure - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataV0** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) -* [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataV0**(value?: *`any`*): [MetadataV0](_metadata_v0_metadata_.metadatav0.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Metadata.ts:26](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L26)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataV0](_metadata_v0_metadata_.metadatav0.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## calls - -**get calls**(): [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> - -*Defined in [Metadata/v0/Metadata.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L60)* - -*__description__*: Wrapped [OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[OuterDispatchCall](_metadata_v0_calls_.outerdispatchcall.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## events - -**get events**(): [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> - -*Defined in [Metadata/v0/Metadata.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L67)* - -*__description__*: Wrapped [OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[OuterEventMetadataEvent](_metadata_v0_events_.outereventmetadataevent.md)> - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## modules - -**get modules**(): [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md)> - -*Defined in [Metadata/v0/Metadata.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L74)* - -*__description__*: Wrapped [RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## getUniqTypes - -▸ **getUniqTypes**(throwError: *`boolean`*): `Array`<`string`> - -*Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* - -*Defined in [Metadata/v0/Metadata.ts:109](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L109)* - -*__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| throwError | `boolean` | - -**Returns:** `Array`<`string`> - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` decodeMetadata - -▸ **decodeMetadata**(value: *`string` \| `Uint8Array` \| `object`*): `object` \| `Uint8Array` - -*Defined in [Metadata/v0/Metadata.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Metadata.ts#L35)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `string` \| `Uint8Array` \| `object` | - -**Returns:** `object` \| `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.callmetadata.html b/docs/types/classes/_metadata_v0_modules_.callmetadata.html deleted file mode 100644 index 8eabde6f32..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.callmetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ CallMetadata

Implements

Constructors

constructor

⊕ new CallMetadata(value?: any): CallMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:79

Parameters:

Name Type
Optional value any

Returns: CallMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

functions

get functions(): Vector<FunctionMetadata>

Defined in Metadata/v0/Modules.ts:90

description: The functions available as FunctionMetadata

Returns: Vector<FunctionMetadata>

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Modules.ts:97

description: The section name

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.callmetadata.md b/docs/types/classes/_metadata_v0_modules_.callmetadata.md deleted file mode 100644 index 4fd63a294c..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.callmetadata.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ CallMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new CallMetadata**(value?: *`any`*): [CallMetadata](_metadata_v0_modules_.callmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L79)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [CallMetadata](_metadata_v0_modules_.callmetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## functions - -**get functions**(): [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)> - -*Defined in [Metadata/v0/Modules.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L90)* - -*__description__*: The functions available as [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)> - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Modules.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L97)* - -*__description__*: The section name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.html b/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.html deleted file mode 100644 index 3b51d0c574..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ FunctionArgumentMetadata

Implements

Constructors

constructor

⊕ new FunctionArgumentMetadata(value?: any): FunctionArgumentMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:17

Parameters:

Name Type
Optional value any

Returns: FunctionArgumentMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Modules.ts:28

description: The argument name

Returns: Text

type

get type(): Type

Defined in Metadata/v0/Modules.ts:35

description: The Type

Returns: Type

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md b/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md deleted file mode 100644 index 59de1164df..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.functionargumentmetadata.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ FunctionArgumentMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new FunctionArgumentMetadata**(value?: *`any`*): [FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L17)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Modules.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L28)* - -*__description__*: The argument name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## type - -**get type**(): [Type](_primitive_type_.type.md) - -*Defined in [Metadata/v0/Modules.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L35)* - -*__description__*: The [Type](_metadata_v0_modules_.functionargumentmetadata.md#type) - -**Returns:** [Type](_primitive_type_.type.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.functionmetadata.html b/docs/types/classes/_metadata_v0_modules_.functionmetadata.html deleted file mode 100644 index 18ffed1a2c..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.functionmetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ FunctionMetadata

Implements

Constructors

constructor

⊕ new FunctionMetadata(value?: any): FunctionMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:40

Parameters:

Name Type
Optional value any

Returns: FunctionMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

arguments

get arguments(): Vector<FunctionArgumentMetadata>

Defined in Metadata/v0/Modules.ts:53

description: The FunctionArgumentMetadata for arguments

Returns: Vector<FunctionArgumentMetadata>

documentation

get documentation(): Vector<Text>

Defined in Metadata/v0/Modules.ts:60

description: The Text documentation

Returns: Vector<Text>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

id

get id(): U16

Defined in Metadata/v0/Modules.ts:67

description: The [sectionIndex, methodIndex] call id

Returns: U16

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Modules.ts:74

description: The call name

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.functionmetadata.md b/docs/types/classes/_metadata_v0_modules_.functionmetadata.md deleted file mode 100644 index e3120a09ca..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.functionmetadata.md +++ /dev/null @@ -1,496 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ FunctionMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new FunctionMetadata**(value?: *`any`*): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L40)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## arguments - -**get arguments**(): [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> - -*Defined in [Metadata/v0/Modules.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L53)* - -*__description__*: The [FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md) for arguments - -**Returns:** [Vector](_codec_vector_.vector.md)<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> - -___ - - -## documentation - -**get documentation**(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -*Defined in [Metadata/v0/Modules.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L60)* - -*__description__*: The [Text](_primitive_text_.text.md) documentation - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## id - -**get id**(): [U16](_primitive_u16_.u16.md) - -*Defined in [Metadata/v0/Modules.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L67)* - -*__description__*: The `[sectionIndex, methodIndex]` call id - -**Returns:** [U16](_primitive_u16_.u16.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Modules.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L74)* - -*__description__*: The call name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.maptype.html b/docs/types/classes/_metadata_v0_modules_.maptype.html deleted file mode 100644 index e1d2cd51c3..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.maptype.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MapType

Implements

Constructors

constructor

⊕ new MapType(value?: any): MapType

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:138

Parameters:

Name Type
Optional value any

Returns: MapType

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

key

get key(): Type

Defined in Metadata/v0/Modules.ts:149

description: The mapped key as Type

Returns: Type

value

get value(): Type

Defined in Metadata/v0/Modules.ts:156

description: The mapped value as Type

Returns: Type

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.maptype.md b/docs/types/classes/_metadata_v0_modules_.maptype.md deleted file mode 100644 index a8d98bd998..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.maptype.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MapType** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MapType**(value?: *`any`*): [MapType](_metadata_v0_modules_.maptype.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:138](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L138)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MapType](_metadata_v0_modules_.maptype.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## key - -**get key**(): [Type](_primitive_type_.type.md) - -*Defined in [Metadata/v0/Modules.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L149)* - -*__description__*: The mapped key as [Type](_metadata_v0_modules_.maptype.md#type) - -**Returns:** [Type](_primitive_type_.type.md) - -___ - - -## value - -**get value**(): [Type](_primitive_type_.type.md) - -*Defined in [Metadata/v0/Modules.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L156)* - -*__description__*: The mapped value as [Type](_metadata_v0_modules_.maptype.md#type) - -**Returns:** [Type](_primitive_type_.type.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.modulemetadata.html b/docs/types/classes/_metadata_v0_modules_.modulemetadata.html deleted file mode 100644 index d757ce4810..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.modulemetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ ModuleMetadata

Implements

Constructors

constructor

⊕ new ModuleMetadata(value?: any): ModuleMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:102

Parameters:

Name Type
Optional value any

Returns: ModuleMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

call

get call(): CallMetadata

Defined in Metadata/v0/Modules.ts:113

description: The calls as CallMetadata

Returns: CallMetadata

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v0/Modules.ts:120

description: The name

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.modulemetadata.md b/docs/types/classes/_metadata_v0_modules_.modulemetadata.md deleted file mode 100644 index 45fb06776f..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.modulemetadata.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ ModuleMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ModuleMetadata**(value?: *`any`*): [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L102)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## call - -**get call**(): [CallMetadata](_metadata_v0_modules_.callmetadata.md) - -*Defined in [Metadata/v0/Modules.ts:113](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L113)* - -*__description__*: The calls as [CallMetadata](_metadata_v0_modules_.callmetadata.md) - -**Returns:** [CallMetadata](_metadata_v0_modules_.callmetadata.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Modules.ts:120](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L120)* - -*__description__*: The name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html b/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html deleted file mode 100644 index 4800fda6a8..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ RuntimeModuleMetadata

Implements

Constructors

constructor

⊕ new RuntimeModuleMetadata(value?: any): RuntimeModuleMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:281

Parameters:

Name Type
Optional value any

Returns: RuntimeModuleMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

module

get module(): ModuleMetadata

Defined in Metadata/v0/Modules.ts:293

description: The ModuleMetadata

Returns: ModuleMetadata

prefix

get prefix(): Text

Defined in Metadata/v0/Modules.ts:300

description: The prefix

Returns: Text

storage

get storage(): Option<StorageMetadata>

Defined in Metadata/v0/Modules.ts:307

description: The optional StorageMetadata

Returns: Option<StorageMetadata>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md b/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md deleted file mode 100644 index ce4e256e79..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.runtimemodulemetadata.md +++ /dev/null @@ -1,483 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ RuntimeModuleMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new RuntimeModuleMetadata**(value?: *`any`*): [RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:281](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L281)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [RuntimeModuleMetadata](_metadata_v0_modules_.runtimemodulemetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## module - -**get module**(): [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) - -*Defined in [Metadata/v0/Modules.ts:293](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L293)* - -*__description__*: The [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) - -**Returns:** [ModuleMetadata](_metadata_v0_modules_.modulemetadata.md) - -___ - - -## prefix - -**get prefix**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Modules.ts:300](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L300)* - -*__description__*: The prefix - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## storage - -**get storage**(): [Option](_codec_option_.option.md)<[StorageMetadata](_metadata_v0_modules_.storagemetadata.md)> - -*Defined in [Metadata/v0/Modules.ts:307](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L307)* - -*__description__*: The optional [StorageMetadata](_metadata_v0_modules_.storagemetadata.md) - -**Returns:** [Option](_codec_option_.option.md)<[StorageMetadata](_metadata_v0_modules_.storagemetadata.md)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html b/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html deleted file mode 100644 index b95385a23f..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ StorageFunctionMetadata

Implements

Constructors

constructor

⊕ new StorageFunctionMetadata(value?: StorageFunctionMetadataValue | Uint8Array): StorageFunctionMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:211

Parameters:

Name Type
Optional value StorageFunctionMetadataValue | Uint8Array

Returns: StorageFunctionMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

default

get default(): Bytes

Defined in Metadata/v0/Modules.ts:225

description: The default value of the storage function

Returns: Bytes

documentation

get documentation(): Vector<Text>

Defined in Metadata/v0/Modules.ts:232

description: The Text documentation

Returns: Vector<Text>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

modifier

get modifier(): StorageFunctionModifier

Defined in Metadata/v0/Modules.ts:246

description: The modifier

Returns: StorageFunctionModifier

name

get name(): Text

Defined in Metadata/v0/Modules.ts:239

description: The key name

Returns: Text

type

get type(): StorageFunctionType

Defined in Metadata/v0/Modules.ts:253

description: The StorageFunctionType

Returns: StorageFunctionType

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md b/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md deleted file mode 100644 index 4a440128b1..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmetadata.md +++ /dev/null @@ -1,509 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StorageFunctionMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new StorageFunctionMetadata**(value?: *`StorageFunctionMetadataValue` \| `Uint8Array`*): [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:211](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L211)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `StorageFunctionMetadataValue` \| `Uint8Array` | - -**Returns:** [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## default - -**get default**(): [Bytes](_primitive_bytes_.bytes.md) - -*Defined in [Metadata/v0/Modules.ts:225](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L225)* - -*__description__*: The default value of the storage function - -**Returns:** [Bytes](_primitive_bytes_.bytes.md) - -___ - - -## documentation - -**get documentation**(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -*Defined in [Metadata/v0/Modules.ts:232](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L232)* - -*__description__*: The [Text](_primitive_text_.text.md) documentation - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## modifier - -**get modifier**(): [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md) - -*Defined in [Metadata/v0/Modules.ts:246](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L246)* - -*__description__*: The modifier - -**Returns:** [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md) - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Modules.ts:239](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L239)* - -*__description__*: The key name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## type - -**get type**(): [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) - -*Defined in [Metadata/v0/Modules.ts:253](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L253)* - -*__description__*: The [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) - -**Returns:** [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html b/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html deleted file mode 100644 index 8c8fbcd6d5..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Enum

↳ StorageFunctionModifier

Implements

Constructors

constructor

⊕ new StorageFunctionModifier(value?: any): StorageFunctionModifier

Overrides Enum.constructor

Defined in Metadata/v0/Modules.ts:125

Parameters:

Name Type
Optional value any

Returns: StorageFunctionModifier

Accessors

encodedLength

get encodedLength(): number

Inherited from Enum.encodedLength

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Enum.isEmpty

Defined in codec/Enum.ts:71

description: Checks if the value is an empty value (always false)

Returns: boolean

isOptional

get isOptional(): boolean

Defined in Metadata/v0/Modules.ts:133

description: true if the storage entry is optional

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Enum.eq

Defined in codec/Enum.ts:78

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

Defined in codec/Enum.ts:91

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

Defined in codec/Enum.ts:98

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

Defined in codec/Enum.ts:105

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

Defined in codec/Enum.ts:112

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Enum.toU8a

Defined in codec/Enum.ts:120

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

Inherited from Enum.decodeEnum

Defined in codec/Enum.ts:47

Parameters:

Name Type
def EnumDef
value Enum | Uint8Array | string | number

Returns: number | undefined

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md b/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md deleted file mode 100644 index 9d1d68c656..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctionmodifier.md +++ /dev/null @@ -1,215 +0,0 @@ - - -# Hierarchy - -↳ [Enum](_codec_enum_.enum.md) - -**↳ StorageFunctionModifier** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new StorageFunctionModifier**(value?: *`any`*): [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md) - -*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L125)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [StorageFunctionModifier](_metadata_v0_modules_.storagefunctionmodifier.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* - -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Enum](_codec_enum_.enum.md).[isEmpty](_codec_enum_.enum.md#isempty)* - -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71)* - -*__description__*: Checks if the value is an empty value (always false) - -**Returns:** `boolean` - -___ - - -## isOptional - -**get isOptional**(): `boolean` - -*Defined in [Metadata/v0/Modules.ts:133](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L133)* - -*__description__*: `true` if the storage entry is optional - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* - -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* - -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* - -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* - -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* - -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* - -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeEnum - -▸ **decodeEnum**(def: *`EnumDef`*, value: *[Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number`*): `number` \| `undefined` - -*Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* - -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| def | `EnumDef` | -| value | [Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number` | - -**Returns:** `number` \| `undefined` - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.html b/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.html deleted file mode 100644 index 5df786cc43..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ EnumType<PlainType | MapType>

↳ StorageFunctionType

Implements

Constructors

constructor

⊕ new StorageFunctionType(value?: any, index?: undefined | number): StorageFunctionType

Overrides EnumType.constructor

Defined in Metadata/v0/Modules.ts:164

Parameters:

Name Type
Optional value any
Optional index undefined | number

Returns: StorageFunctionType

Accessors

asMap

get asMap(): MapType

Defined in Metadata/v0/Modules.ts:182

description: The value as a mapped value

Returns: MapType

asType

get asType(): PlainType

Defined in Metadata/v0/Modules.ts:189

description: The value as a Type value

Returns: PlainType

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isMap

get isMap(): boolean

Defined in Metadata/v0/Modules.ts:175

description: true if the storage entry is a map

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Overrides EnumType.toString

Defined in Metadata/v0/Modules.ts:196

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md b/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md deleted file mode 100644 index 661a29d172..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagefunctiontype.md +++ /dev/null @@ -1,319 +0,0 @@ - - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<`PlainType` \| [MapType](_metadata_v0_modules_.maptype.md)> - -**↳ StorageFunctionType** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new StorageFunctionType**(value?: *`any`*, index?: *`undefined` \| `number`*): [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:164](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L164)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | -| `Optional` index | `undefined` \| `number` | - -**Returns:** [StorageFunctionType](_metadata_v0_modules_.storagefunctiontype.md) - -___ - -# Accessors - - - -## asMap - -**get asMap**(): [MapType](_metadata_v0_modules_.maptype.md) - -*Defined in [Metadata/v0/Modules.ts:182](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L182)* - -*__description__*: The value as a mapped value - -**Returns:** [MapType](_metadata_v0_modules_.maptype.md) - -___ - - -## asType - -**get asType**(): `PlainType` - -*Defined in [Metadata/v0/Modules.ts:189](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L189)* - -*__description__*: The value as a [Type](_codec_struct_.struct.md#type) value - -**Returns:** `PlainType` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isMap - -**get isMap**(): `boolean` - -*Defined in [Metadata/v0/Modules.ts:175](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L175)* - -*__description__*: `true` if the storage entry is a map - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [Metadata/v0/Modules.ts:196](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L196)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v0_modules_.storagemetadata.html b/docs/types/classes/_metadata_v0_modules_.storagemetadata.html deleted file mode 100644 index 7f5d49b4f3..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagemetadata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ StorageMetadata

Implements

Constructors

constructor

⊕ new StorageMetadata(value?: any): StorageMetadata

Overrides Struct.constructor

Defined in Metadata/v0/Modules.ts:258

Parameters:

Name Type
Optional value any

Returns: StorageMetadata

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

functions

get functions(): Vector<StorageFunctionMetadata>

Defined in Metadata/v0/Modules.ts:269

description: The StorageFunctionMetadata for the section

Returns: Vector<StorageFunctionMetadata>

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

prefix

get prefix(): Text

Defined in Metadata/v0/Modules.ts:276

description: The section prefix

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v0_modules_.storagemetadata.md b/docs/types/classes/_metadata_v0_modules_.storagemetadata.md deleted file mode 100644 index 7c963878fc..0000000000 --- a/docs/types/classes/_metadata_v0_modules_.storagemetadata.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StorageMetadata** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new StorageMetadata**(value?: *`any`*): [StorageMetadata](_metadata_v0_modules_.storagemetadata.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v0/Modules.ts:258](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L258)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [StorageMetadata](_metadata_v0_modules_.storagemetadata.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## functions - -**get functions**(): [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md)> - -*Defined in [Metadata/v0/Modules.ts:269](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L269)* - -*__description__*: The [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) for the section - -**Returns:** [Vector](_codec_vector_.vector.md)<[StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md)> - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## prefix - -**get prefix**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v0/Modules.ts:276](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v0/Modules.ts#L276)* - -*__description__*: The section prefix - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacall.html b/docs/types/classes/_metadata_v1_calls_.metadatacall.html deleted file mode 100644 index 40f064c6d4..0000000000 --- a/docs/types/classes/_metadata_v1_calls_.metadatacall.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MetadataCall

description: The definition of a call

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataCall

Implements

Constructors

constructor

⊕ new MetadataCall(value?: any): MetadataCall

Overrides Struct.constructor

Defined in Metadata/v1/Calls.ts:38

Parameters:

Name Type
Optional value any

Returns: MetadataCall

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

args

get args(): Vector<MetadataCallArg>

Defined in Metadata/v1/Calls.ts:53

description: The MetadataCallArg for arguments

Returns: Vector<MetadataCallArg>

docs

get docs(): Vector<Text>

Defined in Metadata/v1/Calls.ts:60

description: The Text documentation

Returns: Vector<Text>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v1/Calls.ts:74

description: The call name

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacall.md b/docs/types/classes/_metadata_v1_calls_.metadatacall.md deleted file mode 100644 index bb79562fa5..0000000000 --- a/docs/types/classes/_metadata_v1_calls_.metadatacall.md +++ /dev/null @@ -1,487 +0,0 @@ - - -*__name__*: MetadataCall - -*__description__*: The definition of a call - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataCall** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataCall**(value?: *`any`*): [MetadataCall](_metadata_v1_calls_.metadatacall.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v1/Calls.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L38)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataCall](_metadata_v1_calls_.metadatacall.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## args - -**get args**(): [Vector](_codec_vector_.vector.md)<[MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md)> - -*Defined in [Metadata/v1/Calls.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L53)* - -*__description__*: The [MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md) for arguments - -**Returns:** [Vector](_codec_vector_.vector.md)<[MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md)> - -___ - - -## docs - -**get docs**(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -*Defined in [Metadata/v1/Calls.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L60)* - -*__description__*: The [Text](_primitive_text_.text.md) documentation - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v1/Calls.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L74)* - -*__description__*: The call name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.html b/docs/types/classes/_metadata_v1_calls_.metadatacallarg.html deleted file mode 100644 index e3defe6371..0000000000 --- a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataCallArg

Implements

Constructors

constructor

⊕ new MetadataCallArg(value?: any): MetadataCallArg

Overrides Struct.constructor

Defined in Metadata/v1/Calls.ts:10

Parameters:

Name Type
Optional value any

Returns: MetadataCallArg

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v1/Calls.ts:21

description: The argument name

Returns: Text

type

get type(): Type

Defined in Metadata/v1/Calls.ts:28

description: The Type

Returns: Type

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md b/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md deleted file mode 100644 index d255b77675..0000000000 --- a/docs/types/classes/_metadata_v1_calls_.metadatacallarg.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataCallArg** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataCallArg**(value?: *`any`*): [MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v1/Calls.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L10)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataCallArg](_metadata_v1_calls_.metadatacallarg.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v1/Calls.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L21)* - -*__description__*: The argument name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## type - -**get type**(): [Type](_primitive_type_.type.md) - -*Defined in [Metadata/v1/Calls.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Calls.ts#L28)* - -*__description__*: The [Type](_metadata_v1_calls_.metadatacallarg.md#type) - -**Returns:** [Type](_primitive_type_.type.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_events_.metadataevent.html b/docs/types/classes/_metadata_v1_events_.metadataevent.html deleted file mode 100644 index d26c1cfb05..0000000000 --- a/docs/types/classes/_metadata_v1_events_.metadataevent.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MetadataEvent

description: The definition of an event

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataEvent

Implements

Constructors

constructor

⊕ new MetadataEvent(value?: any): MetadataEvent

Overrides Struct.constructor

Defined in Metadata/v1/Events.ts:15

Parameters:

Name Type
Optional value any

Returns: MetadataEvent

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

args

get args(): Vector<Type>

Defined in Metadata/v1/Events.ts:27

description: The Type for args

Returns: Vector<Type>

docs

get docs(): Vector<Text>

Defined in Metadata/v1/Events.ts:34

description: The Text documentation

Returns: Vector<Text>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v1/Events.ts:41

description: The call name

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_events_.metadataevent.md b/docs/types/classes/_metadata_v1_events_.metadataevent.md deleted file mode 100644 index 5a5566c43d..0000000000 --- a/docs/types/classes/_metadata_v1_events_.metadataevent.md +++ /dev/null @@ -1,487 +0,0 @@ - - -*__name__*: MetadataEvent - -*__description__*: The definition of an event - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataEvent** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataEvent**(value?: *`any`*): [MetadataEvent](_metadata_v1_events_.metadataevent.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v1/Events.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataEvent](_metadata_v1_events_.metadataevent.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## args - -**get args**(): [Vector](_codec_vector_.vector.md)<[Type](_primitive_type_.type.md)> - -*Defined in [Metadata/v1/Events.ts:27](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L27)* - -*__description__*: The [Type](_metadata_v1_events_.metadataevent.md#type) for args - -**Returns:** [Vector](_codec_vector_.vector.md)<[Type](_primitive_type_.type.md)> - -___ - - -## docs - -**get docs**(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -*Defined in [Metadata/v1/Events.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L34)* - -*__description__*: The [Text](_primitive_text_.text.md) documentation - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v1/Events.ts:41](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Events.ts#L41)* - -*__description__*: The call name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_metadata_.metadatamodule.html b/docs/types/classes/_metadata_v1_metadata_.metadatamodule.html deleted file mode 100644 index 5bb577006a..0000000000 --- a/docs/types/classes/_metadata_v1_metadata_.metadatamodule.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MetadataModule

description: The definition of a module in the system

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataModule

Implements

Constructors

constructor

⊕ new MetadataModule(value?: any): MetadataModule

Overrides Struct.constructor

Defined in Metadata/v1/Metadata.ts:22

Parameters:

Name Type
Optional value any

Returns: MetadataModule

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

calls

get calls(): Option<Vector<MetadataCall>>

Defined in Metadata/v1/Metadata.ts:36

description: the module calls

Returns: Option<Vector<MetadataCall>>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

events

get events(): Option<Vector<MetadataEvent>>

Defined in Metadata/v1/Metadata.ts:43

description: the module events

Returns: Option<Vector<MetadataEvent>>

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

name

get name(): Text

Defined in Metadata/v1/Metadata.ts:50

description: the module name

Returns: Text

prefix

get prefix(): Text

Defined in Metadata/v1/Metadata.ts:57

description: the module prefix

Returns: Text

storage

get storage(): Option<Vector<MetadataStorage>>

Defined in Metadata/v1/Metadata.ts:64

description: the associated module storage

Returns: Option<Vector<MetadataStorage>>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_metadata_.metadatamodule.md b/docs/types/classes/_metadata_v1_metadata_.metadatamodule.md deleted file mode 100644 index a650c398f7..0000000000 --- a/docs/types/classes/_metadata_v1_metadata_.metadatamodule.md +++ /dev/null @@ -1,513 +0,0 @@ - - -*__name__*: MetadataModule - -*__description__*: The definition of a module in the system - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataModule** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataModule**(value?: *`any`*): [MetadataModule](_metadata_v1_metadata_.metadatamodule.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v1/Metadata.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataModule](_metadata_v1_metadata_.metadatamodule.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## calls - -**get calls**(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataCall](_metadata_v1_calls_.metadatacall.md)>> - -*Defined in [Metadata/v1/Metadata.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L36)* - -*__description__*: the module calls - -**Returns:** [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataCall](_metadata_v1_calls_.metadatacall.md)>> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## events - -**get events**(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataEvent](_metadata_v1_events_.metadataevent.md)>> - -*Defined in [Metadata/v1/Metadata.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L43)* - -*__description__*: the module events - -**Returns:** [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataEvent](_metadata_v1_events_.metadataevent.md)>> - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v1/Metadata.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L50)* - -*__description__*: the module name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## prefix - -**get prefix**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v1/Metadata.ts:57](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L57)* - -*__description__*: the module prefix - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## storage - -**get storage**(): [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataStorage](_metadata_v1_storage_.metadatastorage.md)>> - -*Defined in [Metadata/v1/Metadata.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L64)* - -*__description__*: the associated module storage - -**Returns:** [Option](_codec_option_.option.md)<[Vector](_codec_vector_.vector.md)<[MetadataStorage](_metadata_v1_storage_.metadatastorage.md)>> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_metadata_.metadatav1.html b/docs/types/classes/_metadata_v1_metadata_.metadatav1.html deleted file mode 100644 index 98aac04664..0000000000 --- a/docs/types/classes/_metadata_v1_metadata_.metadatav1.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MetadataV1

description: The runtime metadata as a decoded structure

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataV1

Implements

Constructors

constructor

⊕ new MetadataV1(value?: any): MetadataV1

Overrides Struct.constructor

Defined in Metadata/v1/Metadata.ts:74

Parameters:

Name Type
Optional value any

Returns: MetadataV1

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

modules

get modules(): Vector<MetadataModule>

Defined in Metadata/v1/Metadata.ts:84

description: The associated modules for this structure

Returns: Vector<MetadataModule>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

getUniqTypes

▸ getUniqTypes(throwError: boolean): Array<string>

Implementation of MetadataInterface.getUniqTypes

Defined in Metadata/v1/Metadata.ts:123

description: Helper to retrieve a list of all type that are found, sorted and de-deuplicated

Parameters:

Name Type
throwError boolean

Returns: Array<string>

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_metadata_.metadatav1.md b/docs/types/classes/_metadata_v1_metadata_.metadatav1.md deleted file mode 100644 index f376e5ec62..0000000000 --- a/docs/types/classes/_metadata_v1_metadata_.metadatav1.md +++ /dev/null @@ -1,483 +0,0 @@ - - -*__name__*: MetadataV1 - -*__description__*: The runtime metadata as a decoded structure - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataV1** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) -* [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataV1**(value?: *`any`*): [MetadataV1](_metadata_v1_metadata_.metadatav1.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v1/Metadata.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L74)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataV1](_metadata_v1_metadata_.metadatav1.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## modules - -**get modules**(): [Vector](_codec_vector_.vector.md)<[MetadataModule](_metadata_v1_metadata_.metadatamodule.md)> - -*Defined in [Metadata/v1/Metadata.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L84)* - -*__description__*: The associated modules for this structure - -**Returns:** [Vector](_codec_vector_.vector.md)<[MetadataModule](_metadata_v1_metadata_.metadatamodule.md)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## getUniqTypes - -▸ **getUniqTypes**(throwError: *`boolean`*): `Array`<`string`> - -*Implementation of [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md).[getUniqTypes](../interfaces/_metadata_types_.metadatainterface.md#getuniqtypes)* - -*Defined in [Metadata/v1/Metadata.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Metadata.ts#L123)* - -*__description__*: Helper to retrieve a list of all type that are found, sorted and de-deuplicated - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| throwError | `boolean` | - -**Returns:** `Array`<`string`> - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_storage_.default.html b/docs/types/classes/_metadata_v1_storage_.default.html deleted file mode 100644 index a8515d262d..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.default.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

Null

↳ Default

Implements

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_metadata_v1_storage_.default.md b/docs/types/classes/_metadata_v1_storage_.default.md deleted file mode 100644 index 5058bdb34a..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.default.md +++ /dev/null @@ -1,145 +0,0 @@ - - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Default** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_metadata_v1_storage_.maptype.html b/docs/types/classes/_metadata_v1_storage_.maptype.html deleted file mode 100644 index 61b398369b..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.maptype.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MapType

Implements

Constructors

constructor

⊕ new MapType(value?: any): MapType

Overrides Struct.constructor

Defined in Metadata/v1/Storage.ts:37

Parameters:

Name Type
Optional value any

Returns: MapType

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

key

get key(): Type

Defined in Metadata/v1/Storage.ts:48

description: The mapped key as Type

Returns: Type

value

get value(): Type

Defined in Metadata/v1/Storage.ts:55

description: The mapped value as Type

Returns: Type

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_storage_.maptype.md b/docs/types/classes/_metadata_v1_storage_.maptype.md deleted file mode 100644 index 207e53595f..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.maptype.md +++ /dev/null @@ -1,470 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MapType** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MapType**(value?: *`any`*): [MapType](_metadata_v1_storage_.maptype.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v1/Storage.ts:37](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L37)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MapType](_metadata_v1_storage_.maptype.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## key - -**get key**(): [Type](_primitive_type_.type.md) - -*Defined in [Metadata/v1/Storage.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L48)* - -*__description__*: The mapped key as [Type](_metadata_v1_storage_.maptype.md#type) - -**Returns:** [Type](_primitive_type_.type.md) - -___ - - -## value - -**get value**(): [Type](_primitive_type_.type.md) - -*Defined in [Metadata/v1/Storage.ts:55](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L55)* - -*__description__*: The mapped value as [Type](_metadata_v1_storage_.maptype.md#type) - -**Returns:** [Type](_primitive_type_.type.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastorage.html b/docs/types/classes/_metadata_v1_storage_.metadatastorage.html deleted file mode 100644 index 64ab7e6b08..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.metadatastorage.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MetadataModule

description: The definition of a storage function

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MetadataStorage

Implements

Constructors

constructor

⊕ new MetadataStorage(value?: any): MetadataStorage

Overrides Struct.constructor

Defined in Metadata/v1/Storage.ts:107

Parameters:

Name Type
Optional value any

Returns: MetadataStorage

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

docs

get docs(): Vector<Text>

Defined in Metadata/v1/Storage.ts:121

description: The Text documentation

Returns: Vector<Text>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

fallback

get fallback(): Bytes

Defined in Metadata/v1/Storage.ts:128

description: The Bytes fallback default

Returns: Bytes

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

modifier

get modifier(): MetadataStorageModifier

Defined in Metadata/v1/Storage.ts:135

description: The [[MetadataArgument]] for arguments

Returns: MetadataStorageModifier

name

get name(): Text

Defined in Metadata/v1/Storage.ts:142

description: The call name

Returns: Text

type

get type(): MetadataStorageType

Defined in Metadata/v1/Storage.ts:149

description: The MetadataStorageType

Returns: MetadataStorageType

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastorage.md b/docs/types/classes/_metadata_v1_storage_.metadatastorage.md deleted file mode 100644 index 9c4fda72ca..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.metadatastorage.md +++ /dev/null @@ -1,513 +0,0 @@ - - -*__name__*: MetadataModule - -*__description__*: The definition of a storage function - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MetadataStorage** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataStorage**(value?: *`any`*): [MetadataStorage](_metadata_v1_storage_.metadatastorage.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [Metadata/v1/Storage.ts:107](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L107)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [MetadataStorage](_metadata_v1_storage_.metadatastorage.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## docs - -**get docs**(): [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -*Defined in [Metadata/v1/Storage.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L121)* - -*__description__*: The [Text](_primitive_text_.text.md) documentation - -**Returns:** [Vector](_codec_vector_.vector.md)<[Text](_primitive_text_.text.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## fallback - -**get fallback**(): [Bytes](_primitive_bytes_.bytes.md) - -*Defined in [Metadata/v1/Storage.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L128)* - -*__description__*: The [Bytes](_primitive_bytes_.bytes.md) fallback default - -**Returns:** [Bytes](_primitive_bytes_.bytes.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## modifier - -**get modifier**(): [MetadataStorageModifier](_metadata_v1_storage_.metadatastoragemodifier.md) - -*Defined in [Metadata/v1/Storage.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L135)* - -*__description__*: The \[\[MetadataArgument\]\] for arguments - -**Returns:** [MetadataStorageModifier](_metadata_v1_storage_.metadatastoragemodifier.md) - -___ - - -## name - -**get name**(): [Text](_primitive_text_.text.md) - -*Defined in [Metadata/v1/Storage.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L142)* - -*__description__*: The call name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## type - -**get type**(): [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) - -*Defined in [Metadata/v1/Storage.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L149)* - -*__description__*: The [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) - -**Returns:** [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html b/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html deleted file mode 100644 index 77a0c17bdc..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ EnumType<Optional | Default>

↳ MetadataStorageModifier

Implements

Constructors

constructor

⊕ new MetadataStorageModifier(value?: any, index?: undefined | number): MetadataStorageModifier

Overrides EnumType.constructor

Defined in Metadata/v1/Storage.ts:17

Parameters:

Name Type
Optional value any
Optional index undefined | number

Returns: MetadataStorageModifier

Accessors

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

isOptional

get isOptional(): boolean

Defined in Metadata/v1/Storage.ts:28

description: true if the storage entry is optional

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides EnumType.toJSON

Defined in Metadata/v1/Storage.ts:32

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md b/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md deleted file mode 100644 index 4d38186ddb..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragemodifier.md +++ /dev/null @@ -1,291 +0,0 @@ - - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<[Optional](_metadata_v1_storage_.optional.md) \| [Default](_metadata_v1_storage_.default.md)> - -**↳ MetadataStorageModifier** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataStorageModifier**(value?: *`any`*, index?: *`undefined` \| `number`*): [MetadataStorageModifier](_metadata_v1_storage_.metadatastoragemodifier.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [Metadata/v1/Storage.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L17)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | -| `Optional` index | `undefined` \| `number` | - -**Returns:** [MetadataStorageModifier](_metadata_v1_storage_.metadatastoragemodifier.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## isOptional - -**get isOptional**(): `boolean` - -*Defined in [Metadata/v1/Storage.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L28)* - -*__description__*: `true` if the storage entry is optional - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [Metadata/v1/Storage.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L32)* - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.html b/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.html deleted file mode 100644 index e119fe0ab8..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ EnumType<PlainType | MapType>

↳ MetadataStorageType

Implements

Constructors

constructor

⊕ new MetadataStorageType(value?: any, index?: undefined | number): MetadataStorageType

Overrides EnumType.constructor

Defined in Metadata/v1/Storage.ts:63

Parameters:

Name Type
Optional value any
Optional index undefined | number

Returns: MetadataStorageType

Accessors

asMap

get asMap(): MapType

Defined in Metadata/v1/Storage.ts:81

description: The value as a mapped value

Returns: MapType

asType

get asType(): PlainType

Defined in Metadata/v1/Storage.ts:88

description: The value as a Type value

Returns: PlainType

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isMap

get isMap(): boolean

Defined in Metadata/v1/Storage.ts:74

description: true if the storage entry is a map

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Overrides EnumType.toString

Defined in Metadata/v1/Storage.ts:95

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md b/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md deleted file mode 100644 index 28b8e03d5f..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.metadatastoragetype.md +++ /dev/null @@ -1,319 +0,0 @@ - - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<[PlainType](_metadata_v1_storage_.plaintype.md) \| [MapType](_metadata_v1_storage_.maptype.md)> - -**↳ MetadataStorageType** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MetadataStorageType**(value?: *`any`*, index?: *`undefined` \| `number`*): [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [Metadata/v1/Storage.ts:63](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L63)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | -| `Optional` index | `undefined` \| `number` | - -**Returns:** [MetadataStorageType](_metadata_v1_storage_.metadatastoragetype.md) - -___ - -# Accessors - - - -## asMap - -**get asMap**(): [MapType](_metadata_v1_storage_.maptype.md) - -*Defined in [Metadata/v1/Storage.ts:81](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L81)* - -*__description__*: The value as a mapped value - -**Returns:** [MapType](_metadata_v1_storage_.maptype.md) - -___ - - -## asType - -**get asType**(): [PlainType](_metadata_v1_storage_.plaintype.md) - -*Defined in [Metadata/v1/Storage.ts:88](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L88)* - -*__description__*: The value as a [Type](_codec_struct_.struct.md#type) value - -**Returns:** [PlainType](_metadata_v1_storage_.plaintype.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isMap - -**get isMap**(): `boolean` - -*Defined in [Metadata/v1/Storage.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L74)* - -*__description__*: `true` if the storage entry is a map - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [Metadata/v1/Storage.ts:95](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/Storage.ts#L95)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_metadata_v1_storage_.optional.html b/docs/types/classes/_metadata_v1_storage_.optional.html deleted file mode 100644 index 4c7480c0fb..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.optional.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

Null

↳ Optional

Implements

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_metadata_v1_storage_.optional.md b/docs/types/classes/_metadata_v1_storage_.optional.md deleted file mode 100644 index c204b985f9..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.optional.md +++ /dev/null @@ -1,145 +0,0 @@ - - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Optional** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_metadata_v1_storage_.plaintype.html b/docs/types/classes/_metadata_v1_storage_.plaintype.html deleted file mode 100644 index 11c1926198..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.plaintype.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Type

↳ PlainType

Implements

Indexable

[index: number]: string

Constructors

constructor

⊕ new PlainType(value?: Text | Uint8Array | string): PlainType

Inherited from Type.constructor

Overrides Text.constructor

Defined in primitive/Type.ts:19

Parameters:

Name Type Default value
Default value value Text | Uint8Array | string ""

Returns: PlainType

Accessors

encodedLength

get encodedLength(): number

Inherited from Type.encodedLength

Overrides Text.encodedLength

Defined in primitive/Type.ts:76

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Text.isEmpty

Defined in primitive/Text.ts:52

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Inherited from Text.length

Overrides String.length

Defined in primitive/Text.ts:59

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<string>

Inherited from String.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:235

Iterator

Returns: IterableIterator<string>

anchor

▸ anchor(name: string): string

Inherited from String.anchor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:454

Returns an HTML anchor element and sets the name attribute to the text value

Parameters:

Name Type Description
name string

Returns: string

big

▸ big(): string

Inherited from String.big

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:457

Returns a HTML element

Returns: string

▸ blink(): string

Inherited from String.blink

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:460

Returns a HTML element

Returns: string

bold

▸ bold(): string

Inherited from String.bold

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:463

Returns a HTML element

Returns: string

charAt

▸ charAt(pos: number): string

Inherited from String.charAt

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:402

Returns the character at the specified index.

Parameters:

Name Type Description
pos number The zero-based index of the desired character.

Returns: string

charCodeAt

▸ charCodeAt(index: number): number

Inherited from String.charCodeAt

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:408

Returns the Unicode value of the character at the specified location.

Parameters:

Name Type Description
index number The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns: number

codePointAt

▸ codePointAt(pos: number): number | undefined

Inherited from String.codePointAt

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:402

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

Parameters:

Name Type
pos number

Returns: number | undefined

concat

▸ concat(...strings: string[]): string

Inherited from String.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:414

Returns a string that contains the concatenation of two or more strings.

Parameters:

Name Type Description
Rest strings string[] The strings to append to the end of the string.

Returns: string

endsWith

▸ endsWith(searchString: string, endPosition?: undefined | number): boolean

Inherited from String.endsWith

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:418

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

Parameters:

Name Type
searchString string
Optional endPosition undefined | number

Returns: boolean

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Text.eq

Defined in primitive/Text.ts:67

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

fixed

▸ fixed(): string

Inherited from String.fixed

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:466

Returns a HTML element

Returns: string

fontcolor

▸ fontcolor(color: string): string

Inherited from String.fontcolor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:469

Returns a HTML element and sets the color attribute value

Parameters:

Name Type
color string

Returns: string

fontsize

▸ fontsize(size: number): string

▸ fontsize(size: string): string

Inherited from String.fontsize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:472

Returns a HTML element and sets the size attribute value

Parameters:

Name Type
size number

Returns: string

Inherited from String.fontsize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:475

Returns a HTML element and sets the size attribute value

Parameters:

Name Type
size string

Returns: string

includes

▸ includes(searchString: string, position?: undefined | number): boolean

Inherited from String.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:411

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

Parameters:

Name Type Description
searchString string search string
Optional position undefined | number If position is undefined, 0 is assumed, so as to search all of the String.

Returns: boolean

indexOf

▸ indexOf(searchString: string, position?: undefined | number): number

Inherited from String.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:421

Returns the position of the first occurrence of a substring.

Parameters:

Name Type Description
searchString string The substring to search for in the string
Optional position undefined | number The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

Returns: number

italics

▸ italics(): string

Inherited from String.italics

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:478

Returns an HTML element

Returns: string

lastIndexOf

▸ lastIndexOf(searchString: string, position?: undefined | number): number

Inherited from String.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:428

Returns the last occurrence of a substring in the string.

Parameters:

Name Type Description
searchString string The substring to search for.
Optional position undefined | number The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns: number

▸ link(url: string): string

Inherited from String.link

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:481

Returns an HTML element and sets the href attribute value

Parameters:

Name Type
url string

Returns: string

localeCompare

▸ localeCompare(that: string): number

Inherited from String.localeCompare

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:434

Determines whether two strings are equivalent in the current locale.

Parameters:

Name Type Description
that string String to compare to target string

Returns: number

match

▸ match(regexp: string | RegExp): RegExpMatchArray | null

Inherited from String.match

Overrides String.match

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:440

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters:

Name Type Description
regexp string | RegExp A variable name or string literal containing the regular expression pattern and flags.

Returns: RegExpMatchArray | null

normalize

▸ normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string

▸ normalize(form?: undefined | string): string

Inherited from String.normalize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:426

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters:

Name Type Description
form "NFC" | "NFD" | "NFKC" | "NFKD" Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns: string

Inherited from String.normalize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:434

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters:

Name Type Description
Optional form undefined | string Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns: string

padEnd

▸ padEnd(maxLength: number, fillString?: undefined | string): string

Inherited from String.padEnd

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:46

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

Parameters:

Name Type Description
maxLength number The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
Optional fillString undefined | string The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns: string

padStart

▸ padStart(maxLength: number, fillString?: undefined | string): string

Inherited from String.padStart

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:33

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

Parameters:

Name Type Description
maxLength number The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
Optional fillString undefined | string The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns: string

repeat

▸ repeat(count: number): string

Inherited from String.repeat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:441

Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

Parameters:

Name Type Description
count number number of copies to append

Returns: string

replace

▸ replace(searchValue: string | RegExp, replaceValue: string): string

▸ replace(searchValue: string | RegExp, replacer: function): string

Inherited from String.replace

Overrides String.replace

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:447

Replaces text in a string, using a regular expression or search string.

Parameters:

Name Type Description
searchValue string | RegExp A string to search for.
replaceValue string A string containing the text to replace for every successful match of searchValue in this string.

Returns: string

Inherited from String.replace

Overrides String.replace

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:454

Replaces text in a string, using a regular expression or search string.

Parameters:

Name Type Description
searchValue string | RegExp A string to search for.
replacer function A function that returns the replacement text.

Returns: string

▸ search(regexp: string | RegExp): number

Inherited from String.search

Overrides String.search

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:460

Finds the first substring match in a regular expression search.

Parameters:

Name Type Description
regexp string | RegExp The regular expression pattern and applicable flags.

Returns: number

slice

▸ slice(start?: undefined | number, end?: undefined | number): string

Inherited from String.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:468

Returns a section of a string.

Parameters:

Name Type Description
Optional start undefined | number The index to the beginning of the specified portion of stringObj.
Optional end undefined | number The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Returns: string

small

▸ small(): string

Inherited from String.small

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:484

Returns a HTML element

Returns: string

split

▸ split(separator: string | RegExp, limit?: undefined | number): string[]

Inherited from String.split

Overrides String.split

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:475

Split a string into substrings using the specified separator and return them as an array.

Parameters:

Name Type Description
separator string | RegExp A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.
Optional limit undefined | number A value used to limit the number of elements returned in the array.

Returns: string[]

startsWith

▸ startsWith(searchString: string, position?: undefined | number): boolean

Inherited from String.startsWith

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:448

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

Parameters:

Name Type
searchString string
Optional position undefined | number

Returns: boolean

strike

▸ strike(): string

Inherited from String.strike

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:487

Returns a HTML element

Returns: string

sub

▸ sub(): string

Inherited from String.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:490

Returns a HTML element

Returns: string

substr

▸ substr(from: number, length?: undefined | number): string

Inherited from String.substr

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:509

Gets a substring beginning at the specified location and having the specified length.

Parameters:

Name Type Description
from number The starting position of the desired substring. The index of the first character in the string is zero.
Optional length undefined | number The number of characters to include in the returned substring.

Returns: string

substring

▸ substring(start: number, end?: undefined | number): string

Inherited from String.substring

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:483

Returns the substring at the specified location within a String object.

Parameters:

Name Type Description
start number The zero-based index number indicating the beginning of the substring.
Optional end undefined | number Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns: string

sup

▸ sup(): string

Inherited from String.sup

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:493

Returns a HTML element

Returns: string

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Text.toHex

Defined in primitive/Text.ts:76

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Text.toJSON

Defined in primitive/Text.ts:83

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleLowerCase

▸ toLocaleLowerCase(): string

Inherited from String.toLocaleLowerCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:489

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Returns: string

toLocaleUpperCase

▸ toLocaleUpperCase(): string

Inherited from String.toLocaleUpperCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:495

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Returns: string

toLowerCase

▸ toLowerCase(): string

Inherited from String.toLowerCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:486

Converts all the alphabetic characters in a string to lowercase.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Text.toString

Overrides String.toString

Defined in primitive/Text.ts:90

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Type.toU8a

Overrides Text.toU8a

Defined in primitive/Type.ts:87

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

toUpperCase

▸ toUpperCase(): string

Inherited from String.toUpperCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:492

Converts all the alphabetic characters in a string to uppercase.

Returns: string

trim

▸ trim(): string

Inherited from String.trim

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:498

Removes the leading and trailing white space and line terminator characters from a string.

Returns: string

trimLeft

▸ trimLeft(): string

Inherited from String.trimLeft

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:152

Removes whitespace from the left end of a string.

Returns: string

trimRight

▸ trimRight(): string

Inherited from String.trimRight

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:154

Removes whitespace from the right end of a string.

Returns: string

valueOf

▸ valueOf(): string

Inherited from String.valueOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:512

Returns the primitive value of the specified object.

Returns: string

- - - diff --git a/docs/types/classes/_metadata_v1_storage_.plaintype.md b/docs/types/classes/_metadata_v1_storage_.plaintype.md deleted file mode 100644 index 25599924ef..0000000000 --- a/docs/types/classes/_metadata_v1_storage_.plaintype.md +++ /dev/null @@ -1,1061 +0,0 @@ - - -# Hierarchy - -↳ [Type](_primitive_type_.type.md) - -**↳ PlainType** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `string` -# Constructors - - - -## constructor - -⊕ **new PlainType**(value?: *[Text](_primitive_text_.text.md) \| `Uint8Array` \| `string`*): [PlainType](_metadata_v1_storage_.plaintype.md) - -*Inherited from [Type](_primitive_type_.type.md).[constructor](_primitive_type_.type.md#constructor)* - -*Overrides [Text](_primitive_text_.text.md).[constructor](_primitive_text_.text.md#constructor)* - -*Defined in [primitive/Type.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L19)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Text](_primitive_text_.text.md) \| `Uint8Array` \| `string` | "" | - -**Returns:** [PlainType](_metadata_v1_storage_.plaintype.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Type](_primitive_type_.type.md).[encodedLength](_primitive_type_.type.md#encodedlength)* - -*Overrides [Text](_primitive_text_.text.md).[encodedLength](_primitive_text_.text.md#encodedlength)* - -*Defined in [primitive/Type.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L76)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Text](_primitive_text_.text.md).[isEmpty](_primitive_text_.text.md#isempty)* - -*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L52)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [Text](_primitive_text_.text.md).[length](_primitive_text_.text.md#length)* - -*Overrides String.length* - -*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L59)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`string`> - -*Inherited from String.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:235* - -Iterator - -**Returns:** `IterableIterator`<`string`> - -___ - - -## anchor - -▸ **anchor**(name: *`string`*): `string` - -*Inherited from String.anchor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:454* - -Returns an HTML anchor element and sets the name attribute to the text value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `string` | | - -**Returns:** `string` - -___ - - -## big - -▸ **big**(): `string` - -*Inherited from String.big* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:457* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## blink - -▸ **blink**(): `string` - -*Inherited from String.blink* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:460* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## bold - -▸ **bold**(): `string` - -*Inherited from String.bold* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:463* - -Returns a **HTML element** - -**Returns:** `string` - -___ - - -## charAt - -▸ **charAt**(pos: *`number`*): `string` - -*Inherited from String.charAt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:402* - -Returns the character at the specified index. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| pos | `number` | The zero-based index of the desired character. | - -**Returns:** `string` - -___ - - -## charCodeAt - -▸ **charCodeAt**(index: *`number`*): `number` - -*Inherited from String.charCodeAt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:408* - -Returns the Unicode value of the character at the specified location. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| index | `number` | The zero-based index of the desired character. If there is no character at the specified index, NaN is returned. | - -**Returns:** `number` - -___ - - -## codePointAt - -▸ **codePointAt**(pos: *`number`*): `number` \| `undefined` - -*Inherited from String.codePointAt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:402* - -Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| pos | `number` | - -**Returns:** `number` \| `undefined` - -___ - - -## concat - -▸ **concat**(...strings: *`string`[]*): `string` - -*Inherited from String.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:414* - -Returns a string that contains the concatenation of two or more strings. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` strings | `string`[] | The strings to append to the end of the string. | - -**Returns:** `string` - -___ - - -## endsWith - -▸ **endsWith**(searchString: *`string`*, endPosition?: *`undefined` \| `number`*): `boolean` - -*Inherited from String.endsWith* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:418* - -Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| searchString | `string` | -| `Optional` endPosition | `undefined` \| `number` | - -**Returns:** `boolean` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Text](_primitive_text_.text.md).[eq](_primitive_text_.text.md#eq)* - -*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L67)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## fixed - -▸ **fixed**(): `string` - -*Inherited from String.fixed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:466* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## fontcolor - -▸ **fontcolor**(color: *`string`*): `string` - -*Inherited from String.fontcolor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:469* - -Returns a HTML element and sets the color attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| color | `string` | - -**Returns:** `string` - -___ - - -## fontsize - -▸ **fontsize**(size: *`number`*): `string` - -▸ **fontsize**(size: *`string`*): `string` - -*Inherited from String.fontsize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:472* - -Returns a HTML element and sets the size attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| size | `number` | - -**Returns:** `string` - -*Inherited from String.fontsize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:475* - -Returns a HTML element and sets the size attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| size | `string` | - -**Returns:** `string` - -___ - - -## includes - -▸ **includes**(searchString: *`string`*, position?: *`undefined` \| `number`*): `boolean` - -*Inherited from String.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:411* - -Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchString | `string` | search string | -| `Optional` position | `undefined` \| `number` | If position is undefined, 0 is assumed, so as to search all of the String. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchString: *`string`*, position?: *`undefined` \| `number`*): `number` - -*Inherited from String.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:421* - -Returns the position of the first occurrence of a substring. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchString | `string` | The substring to search for in the string | -| `Optional` position | `undefined` \| `number` | The index at which to begin searching the String object. If omitted, search starts at the beginning of the string. | - -**Returns:** `number` - -___ - - -## italics - -▸ **italics**(): `string` - -*Inherited from String.italics* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:478* - -Returns an _HTML element_ - -**Returns:** `string` - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchString: *`string`*, position?: *`undefined` \| `number`*): `number` - -*Inherited from String.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:428* - -Returns the last occurrence of a substring in the string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchString | `string` | The substring to search for. | -| `Optional` position | `undefined` \| `number` | The index at which to begin searching. If omitted, the search begins at the end of the string. | - -**Returns:** `number` - -___ - - -## link - -▸ **link**(url: *`string`*): `string` - -*Inherited from String.link* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:481* - -Returns an HTML element and sets the href attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| url | `string` | - -**Returns:** `string` - -___ - - -## localeCompare - -▸ **localeCompare**(that: *`string`*): `number` - -*Inherited from String.localeCompare* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:434* - -Determines whether two strings are equivalent in the current locale. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| that | `string` | String to compare to target string | - -**Returns:** `number` - -___ - - -## match - -▸ **match**(regexp: *`string` \| `RegExp`*): `RegExpMatchArray` \| `null` - -*Inherited from String.match* - -*Overrides String.match* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:440* - -Matches a string with a regular expression, and returns an array containing the results of that search. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| regexp | `string` \| `RegExp` | A variable name or string literal containing the regular expression pattern and flags. | - -**Returns:** `RegExpMatchArray` \| `null` - -___ - - -## normalize - -▸ **normalize**(form: *"NFC" \| "NFD" \| "NFKC" \| "NFKD"*): `string` - -▸ **normalize**(form?: *`undefined` \| `string`*): `string` - -*Inherited from String.normalize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:426* - -Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| form | "NFC" \| "NFD" \| "NFKC" \| "NFKD" | Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC" | - -**Returns:** `string` - -*Inherited from String.normalize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:434* - -Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` form | `undefined` \| `string` | Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC" | - -**Returns:** `string` - -___ - - -## padEnd - -▸ **padEnd**(maxLength: *`number`*, fillString?: *`undefined` \| `string`*): `string` - -*Inherited from String.padEnd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:46* - -Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| maxLength | `number` | The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is. | -| `Optional` fillString | `undefined` \| `string` | The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020). | - -**Returns:** `string` - -___ - - -## padStart - -▸ **padStart**(maxLength: *`number`*, fillString?: *`undefined` \| `string`*): `string` - -*Inherited from String.padStart* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:33* - -Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| maxLength | `number` | The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is. | -| `Optional` fillString | `undefined` \| `string` | The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020). | - -**Returns:** `string` - -___ - - -## repeat - -▸ **repeat**(count: *`number`*): `string` - -*Inherited from String.repeat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:441* - -Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| count | `number` | number of copies to append | - -**Returns:** `string` - -___ - - -## replace - -▸ **replace**(searchValue: *`string` \| `RegExp`*, replaceValue: *`string`*): `string` - -▸ **replace**(searchValue: *`string` \| `RegExp`*, replacer: *`function`*): `string` - -*Inherited from String.replace* - -*Overrides String.replace* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:447* - -Replaces text in a string, using a regular expression or search string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchValue | `string` \| `RegExp` | A string to search for. | -| replaceValue | `string` | A string containing the text to replace for every successful match of searchValue in this string. | - -**Returns:** `string` - -*Inherited from String.replace* - -*Overrides String.replace* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:454* - -Replaces text in a string, using a regular expression or search string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchValue | `string` \| `RegExp` | A string to search for. | -| replacer | `function` | A function that returns the replacement text. | - -**Returns:** `string` - -___ - - -## search - -▸ **search**(regexp: *`string` \| `RegExp`*): `number` - -*Inherited from String.search* - -*Overrides String.search* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:460* - -Finds the first substring match in a regular expression search. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| regexp | `string` \| `RegExp` | The regular expression pattern and applicable flags. | - -**Returns:** `number` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `string` - -*Inherited from String.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:468* - -Returns a section of a string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The index to the beginning of the specified portion of stringObj. | -| `Optional` end | `undefined` \| `number` | The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj. | - -**Returns:** `string` - -___ - - -## small - -▸ **small**(): `string` - -*Inherited from String.small* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:484* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## split - -▸ **split**(separator: *`string` \| `RegExp`*, limit?: *`undefined` \| `number`*): `string`[] - -*Inherited from String.split* - -*Overrides String.split* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:475* - -Split a string into substrings using the specified separator and return them as an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| separator | `string` \| `RegExp` | A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned. | -| `Optional` limit | `undefined` \| `number` | A value used to limit the number of elements returned in the array. | - -**Returns:** `string`[] - -___ - - -## startsWith - -▸ **startsWith**(searchString: *`string`*, position?: *`undefined` \| `number`*): `boolean` - -*Inherited from String.startsWith* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:448* - -Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| searchString | `string` | -| `Optional` position | `undefined` \| `number` | - -**Returns:** `boolean` - -___ - - -## strike - -▸ **strike**(): `string` - -*Inherited from String.strike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:487* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## sub - -▸ **sub**(): `string` - -*Inherited from String.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:490* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## substr - -▸ **substr**(from: *`number`*, length?: *`undefined` \| `number`*): `string` - -*Inherited from String.substr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:509* - -Gets a substring beginning at the specified location and having the specified length. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| from | `number` | The starting position of the desired substring. The index of the first character in the string is zero. | -| `Optional` length | `undefined` \| `number` | The number of characters to include in the returned substring. | - -**Returns:** `string` - -___ - - -## substring - -▸ **substring**(start: *`number`*, end?: *`undefined` \| `number`*): `string` - -*Inherited from String.substring* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:483* - -Returns the substring at the specified location within a String object. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based index number indicating the beginning of the substring. | -| `Optional` end | `undefined` \| `number` | Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned. | - -**Returns:** `string` - -___ - - -## sup - -▸ **sup**(): `string` - -*Inherited from String.sup* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:493* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Text](_primitive_text_.text.md).[toHex](_primitive_text_.text.md#tohex)* - -*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L76)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Text](_primitive_text_.text.md).[toJSON](_primitive_text_.text.md#tojson)* - -*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L83)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleLowerCase - -▸ **toLocaleLowerCase**(): `string` - -*Inherited from String.toLocaleLowerCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:489* - -Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. - -**Returns:** `string` - -___ - - -## toLocaleUpperCase - -▸ **toLocaleUpperCase**(): `string` - -*Inherited from String.toLocaleUpperCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:495* - -Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale. - -**Returns:** `string` - -___ - - -## toLowerCase - -▸ **toLowerCase**(): `string` - -*Inherited from String.toLowerCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:486* - -Converts all the alphabetic characters in a string to lowercase. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Text](_primitive_text_.text.md).[toString](_primitive_text_.text.md#tostring)* - -*Overrides String.toString* - -*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L90)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Type](_primitive_type_.type.md).[toU8a](_primitive_type_.type.md#tou8a)* - -*Overrides [Text](_primitive_text_.text.md).[toU8a](_primitive_text_.text.md#tou8a)* - -*Defined in [primitive/Type.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L87)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## toUpperCase - -▸ **toUpperCase**(): `string` - -*Inherited from String.toUpperCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:492* - -Converts all the alphabetic characters in a string to uppercase. - -**Returns:** `string` - -___ - - -## trim - -▸ **trim**(): `string` - -*Inherited from String.trim* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:498* - -Removes the leading and trailing white space and line terminator characters from a string. - -**Returns:** `string` - -___ - - -## trimLeft - -▸ **trimLeft**(): `string` - -*Inherited from String.trimLeft* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:152* - -Removes whitespace from the left end of a string. - -**Returns:** `string` - -___ - - -## trimRight - -▸ **trimRight**(): `string` - -*Inherited from String.trimRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:154* - -Removes whitespace from the right end of a string. - -**Returns:** `string` - -___ - - -## valueOf - -▸ **valueOf**(): `string` - -*Inherited from String.valueOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:512* - -Returns the primitive value of the specified object. - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_primitive_bool_.bool.html b/docs/types/classes/_primitive_bool_.bool.html deleted file mode 100644 index 20c93c6186..0000000000 --- a/docs/types/classes/_primitive_bool_.bool.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Bool

description: Representation for a boolean value in the system. It extends the base JS Boolean class

Hierarchy

Boolean

↳ Bool

Implements

Constructors

constructor

⊕ new Bool(value?: Bool | Boolean | Uint8Array | boolean | number): Bool

Defined in primitive/Bool.ts:15

Parameters:

Name Type Default value
Default value value Bool | Boolean | Uint8Array | boolean | number false

Returns: Bool

Properties

<Static> Boolean

● Boolean: BooleanConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:540

Accessors

encodedLength

get encodedLength(): number

Defined in primitive/Bool.ts:35

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in primitive/Bool.ts:42

description: Checks if the value is an empty value (always false)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in primitive/Bool.ts:49

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in primitive/Bool.ts:60

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in primitive/Bool.ts:67

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Defined in primitive/Bool.ts:74

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in primitive/Bool.ts:82

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_primitive_bool_.bool.md b/docs/types/classes/_primitive_bool_.bool.md deleted file mode 100644 index 81776df352..0000000000 --- a/docs/types/classes/_primitive_bool_.bool.md +++ /dev/null @@ -1,167 +0,0 @@ - - -*__name__*: Bool - -*__description__*: Representation for a boolean value in the system. It extends the base JS `Boolean` class - -# Hierarchy - - `Boolean` - -**↳ Bool** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Bool**(value?: *[Bool](_primitive_bool_.bool.md) \| `Boolean` \| `Uint8Array` \| `boolean` \| `number`*): [Bool](_primitive_bool_.bool.md) - -*Defined in [primitive/Bool.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L15)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Bool](_primitive_bool_.bool.md) \| `Boolean` \| `Uint8Array` \| `boolean` \| `number` | false | - -**Returns:** [Bool](_primitive_bool_.bool.md) - -___ - -# Properties - - - -## `` Boolean - -**● Boolean**: *`BooleanConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:540* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [primitive/Bool.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L35)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [primitive/Bool.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L42)* - -*__description__*: Checks if the value is an empty value (always false) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [primitive/Bool.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L49)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [primitive/Bool.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L60)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [primitive/Bool.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L67)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [primitive/Bool.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L74)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [primitive/Bool.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bool.ts#L82)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_primitive_bytes_.bytes.html b/docs/types/classes/_primitive_bytes_.bytes.html deleted file mode 100644 index b7281cfd95..0000000000 --- a/docs/types/classes/_primitive_bytes_.bytes.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Bytes

description: A Bytes wrapper for Vec. The significant difference between this and a normal Uint8Array is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same as what is found in Text and Vector)

Hierarchy

↳ U8a

↳ Bytes

↳ StorageData

↳ StorageKey

↳ Other

↳ Justification

↳ HeadData

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Bytes(value?: AnyU8a): Bytes

Overrides U8a.constructor

Defined in primitive/Bytes.ts:18

Parameters:

Name Type
Optional value AnyU8a

Returns: Bytes

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Overrides U8a.encodedLength

Defined in primitive/Bytes.ts:61

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Overrides U8a.toU8a

Defined in primitive/Bytes.ts:69

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_primitive_bytes_.bytes.md b/docs/types/classes/_primitive_bytes_.bytes.md deleted file mode 100644 index 7478122fdf..0000000000 --- a/docs/types/classes/_primitive_bytes_.bytes.md +++ /dev/null @@ -1,845 +0,0 @@ - - -*__name__*: Bytes - -*__description__*: A Bytes wrapper for Vec. The significant difference between this and a normal Uint8Array is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same as what is found in [Text](_primitive_text_.text.md) and [Vector](_codec_vector_.vector.md)) - -# Hierarchy - -↳ [U8a](_codec_u8a_.u8a.md) - -**↳ Bytes** - -↳ [StorageData](_primitive_storagedata_.storagedata.md) - -↳ [StorageKey](_primitive_storagekey_.storagekey.md) - -↳ [Other](_type_digest_.other.md) - -↳ [Justification](_type_justification_.justification.md) - -↳ [HeadData](_type_attestedcandidate_.headdata.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Bytes**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Bytes](_primitive_bytes_.bytes.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Bytes](_primitive_bytes_.bytes.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_primitive_data_.data.html b/docs/types/classes/_primitive_data_.data.html deleted file mode 100644 index 5c122c6b85..0000000000 --- a/docs/types/classes/_primitive_data_.data.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Data

description: A raw data structure. It is just an encoding of a U8a, without any length encoding

Hierarchy

↳ U8a

↳ Data

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Data(value?: AnyU8a): Data

Inherited from U8a.constructor

Defined in codec/U8a.ts:18

Parameters:

Name Type
Optional value AnyU8a

Returns: Data

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_primitive_data_.data.md b/docs/types/classes/_primitive_data_.data.md deleted file mode 100644 index ddfe8e34f7..0000000000 --- a/docs/types/classes/_primitive_data_.data.md +++ /dev/null @@ -1,835 +0,0 @@ - - -*__name__*: Data - -*__description__*: A raw data structure. It is just an encoding of a U8a, without any length encoding - -# Hierarchy - -↳ [U8a](_codec_u8a_.u8a.md) - -**↳ Data** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Data**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Data](_primitive_data_.data.md) - -*Inherited from [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [codec/U8a.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Data](_primitive_data_.data.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_primitive_h160_.h160.html b/docs/types/classes/_primitive_h160_.h160.html deleted file mode 100644 index 8098f68148..0000000000 --- a/docs/types/classes/_primitive_h160_.h160.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: H160

description: Hash containing 160 bits (20 bytes), typically used in blocks, extrinsics and as a sane default for fixed-length hash representations.

Hierarchy

↳ U8aFixed

↳ H160

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new H160(value?: AnyU8a): H160

Overrides U8aFixed.constructor

Defined in primitive/H160.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: H160

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_primitive_h160_.h160.md b/docs/types/classes/_primitive_h160_.h160.md deleted file mode 100644 index d0f3f7633f..0000000000 --- a/docs/types/classes/_primitive_h160_.h160.md +++ /dev/null @@ -1,850 +0,0 @@ - - -*__name__*: H160 - -*__description__*: Hash containing 160 bits (20 bytes), typically used in blocks, extrinsics and as a sane default for fixed-length hash representations. - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ H160** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new H160**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [H160](_primitive_h160_.h160.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H160.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H160.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [H160](_primitive_h160_.h160.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_primitive_h256_.h256.html b/docs/types/classes/_primitive_h256_.h256.html deleted file mode 100644 index 8521884bda..0000000000 --- a/docs/types/classes/_primitive_h256_.h256.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: H256

description: Hash containing 256 bits (32 bytes), typically used in blocks, extrinsics and as a sane default for fixed-length hash representations.

Hierarchy

↳ U8aFixed

↳ H256

↳ Hash

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new H256(value?: AnyU8a): H256

Overrides U8aFixed.constructor

Defined in primitive/H256.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: H256

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_primitive_h256_.h256.md b/docs/types/classes/_primitive_h256_.h256.md deleted file mode 100644 index 002850a714..0000000000 --- a/docs/types/classes/_primitive_h256_.h256.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: H256 - -*__description__*: Hash containing 256 bits (32 bytes), typically used in blocks, extrinsics and as a sane default for fixed-length hash representations. - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ H256** - -↳ [Hash](_type_hash_.hash.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new H256**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [H256](_primitive_h256_.h256.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [H256](_primitive_h256_.h256.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_primitive_h512_.h512.html b/docs/types/classes/_primitive_h512_.h512.html deleted file mode 100644 index ab4956456d..0000000000 --- a/docs/types/classes/_primitive_h512_.h512.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: H512

description: Hash containing 512 bits (64 bytes), typically used for signatures

Hierarchy

↳ U8aFixed

↳ H512

↳ Signature

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new H512(value?: AnyU8a): H512

Overrides U8aFixed.constructor

Defined in primitive/H512.ts:14

Parameters:

Name Type
Optional value AnyU8a

Returns: H512

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_primitive_h512_.h512.md b/docs/types/classes/_primitive_h512_.h512.md deleted file mode 100644 index 3fb8882ae2..0000000000 --- a/docs/types/classes/_primitive_h512_.h512.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: H512 - -*__description__*: Hash containing 512 bits (64 bytes), typically used for signatures - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ H512** - -↳ [Signature](_type_signature_.signature.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new H512**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [H512](_primitive_h512_.h512.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [H512](_primitive_h512_.h512.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_primitive_i128_.i128.html b/docs/types/classes/_primitive_i128_.i128.html deleted file mode 100644 index 775fa797e4..0000000000 --- a/docs/types/classes/_primitive_i128_.i128.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: I128

description: An 128-bit signed integer

Hierarchy

↳ Int

↳ I128

Implements

Constructors

constructor

⊕ new I128(value?: AnyNumber): I128

Overrides Int.constructor

Defined in primitive/I128.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: I128

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_i128_.i128.md b/docs/types/classes/_primitive_i128_.i128.md deleted file mode 100644 index e4fba0100f..0000000000 --- a/docs/types/classes/_primitive_i128_.i128.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: I128 - -*__description__*: An 128-bit signed integer - -# Hierarchy - -↳ [Int](_codec_int_.int.md) - -**↳ I128** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new I128**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [I128](_primitive_i128_.i128.md) - -*Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* - -*Defined in [primitive/I128.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I128.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [I128](_primitive_i128_.i128.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_i16_.i16.html b/docs/types/classes/_primitive_i16_.i16.html deleted file mode 100644 index 9f6406eedc..0000000000 --- a/docs/types/classes/_primitive_i16_.i16.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: I16

description: An 16-bit signed integer

Hierarchy

↳ Int

↳ I16

Implements

Constructors

constructor

⊕ new I16(value?: AnyNumber): I16

Overrides Int.constructor

Defined in primitive/I16.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: I16

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_i16_.i16.md b/docs/types/classes/_primitive_i16_.i16.md deleted file mode 100644 index d5a3b97955..0000000000 --- a/docs/types/classes/_primitive_i16_.i16.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: I16 - -*__description__*: An 16-bit signed integer - -# Hierarchy - -↳ [Int](_codec_int_.int.md) - -**↳ I16** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new I16**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [I16](_primitive_i16_.i16.md) - -*Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* - -*Defined in [primitive/I16.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I16.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [I16](_primitive_i16_.i16.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_i256_.i256.html b/docs/types/classes/_primitive_i256_.i256.html deleted file mode 100644 index 0f7dc8f227..0000000000 --- a/docs/types/classes/_primitive_i256_.i256.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: I256

description: An 256-bit signed integer

Hierarchy

↳ Int

↳ I256

Implements

Constructors

constructor

⊕ new I256(value?: AnyNumber): I256

Overrides Int.constructor

Defined in primitive/I256.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: I256

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_i256_.i256.md b/docs/types/classes/_primitive_i256_.i256.md deleted file mode 100644 index 4b0e1a9e4b..0000000000 --- a/docs/types/classes/_primitive_i256_.i256.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: I256 - -*__description__*: An 256-bit signed integer - -# Hierarchy - -↳ [Int](_codec_int_.int.md) - -**↳ I256** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new I256**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [I256](_primitive_i256_.i256.md) - -*Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* - -*Defined in [primitive/I256.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I256.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [I256](_primitive_i256_.i256.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_i32_.i32.html b/docs/types/classes/_primitive_i32_.i32.html deleted file mode 100644 index 5c96515c58..0000000000 --- a/docs/types/classes/_primitive_i32_.i32.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: I32

description: An 32-bit signed integer

Hierarchy

↳ Int

↳ I32

Implements

Constructors

constructor

⊕ new I32(value?: AnyNumber): I32

Overrides Int.constructor

Defined in primitive/I32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: I32

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_i32_.i32.md b/docs/types/classes/_primitive_i32_.i32.md deleted file mode 100644 index 42a30e737f..0000000000 --- a/docs/types/classes/_primitive_i32_.i32.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: I32 - -*__description__*: An 32-bit signed integer - -# Hierarchy - -↳ [Int](_codec_int_.int.md) - -**↳ I32** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new I32**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [I32](_primitive_i32_.i32.md) - -*Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* - -*Defined in [primitive/I32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [I32](_primitive_i32_.i32.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_i64_.i64.html b/docs/types/classes/_primitive_i64_.i64.html deleted file mode 100644 index 3db54ed570..0000000000 --- a/docs/types/classes/_primitive_i64_.i64.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: I64

description: An 64-bit signed integer

Hierarchy

↳ Int

↳ I64

Implements

Constructors

constructor

⊕ new I64(value?: AnyNumber): I64

Overrides Int.constructor

Defined in primitive/I64.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: I64

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_i64_.i64.md b/docs/types/classes/_primitive_i64_.i64.md deleted file mode 100644 index 94a6daa6db..0000000000 --- a/docs/types/classes/_primitive_i64_.i64.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: I64 - -*__description__*: An 64-bit signed integer - -# Hierarchy - -↳ [Int](_codec_int_.int.md) - -**↳ I64** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new I64**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [I64](_primitive_i64_.i64.md) - -*Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* - -*Defined in [primitive/I64.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I64.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [I64](_primitive_i64_.i64.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_i8_.i8.html b/docs/types/classes/_primitive_i8_.i8.html deleted file mode 100644 index 159f6ef6d8..0000000000 --- a/docs/types/classes/_primitive_i8_.i8.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: I8

description: An 8-bit signed integer

Hierarchy

↳ Int

↳ I8

↳ LocKPeriods

↳ Vote

Implements

Constructors

constructor

⊕ new I8(value?: AnyNumber): I8

Overrides Int.constructor

Defined in primitive/I8.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: I8

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_i8_.i8.md b/docs/types/classes/_primitive_i8_.i8.md deleted file mode 100644 index 8f33a6e0e6..0000000000 --- a/docs/types/classes/_primitive_i8_.i8.md +++ /dev/null @@ -1,2030 +0,0 @@ - - -*__name__*: I8 - -*__description__*: An 8-bit signed integer - -# Hierarchy - -↳ [Int](_codec_int_.int.md) - -**↳ I8** - -↳ [LocKPeriods](_type_lockperiods_.lockperiods.md) - -↳ [Vote](_type_vote_.vote.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new I8**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [I8](_primitive_i8_.i8.md) - -*Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* - -*Defined in [primitive/I8.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I8.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [I8](_primitive_i8_.i8.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_method_.method.html b/docs/types/classes/_primitive_method_.method.html deleted file mode 100644 index 39e485d32c..0000000000 --- a/docs/types/classes/_primitive_method_.method.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Method

description: Extrinsic function descriptor, as defined in https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node.

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Method

↳ Proposal

Implements

Constructors

constructor

⊕ new Method(value: any, meta?: FunctionMetadata): Method

Overrides Struct.constructor

Defined in primitive/Method.ts:70

Parameters:

Name Type
value any
Optional meta FunctionMetadata

Returns: Method

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

args

get args(): Array<Codec>

Defined in primitive/Method.ts:192

description: The arguments for the function call

Returns: Array<Codec>

argsDef

get argsDef(): ArgsDef

Defined in primitive/Method.ts:200

description: Thge argument defintions

Returns: ArgsDef

callIndex

get callIndex(): Uint8Array

Defined in primitive/Method.ts:207

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array

data

get data(): Uint8Array

Defined in primitive/Method.ts:214

description: The encoded data

Returns: Uint8Array

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

hasOrigin

get hasOrigin(): boolean

Defined in primitive/Method.ts:221

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

meta

get meta(): FunctionMetadata

Defined in primitive/Method.ts:230

description: The FunctionMetadata

Returns: FunctionMetadata

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

Defined in primitive/Method.ts:140

Parameters:

Name Type
Optional meta FunctionMetadata

Returns: Array<FunctionArgumentMetadata>

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

Defined in primitive/Method.ts:156

Parameters:

Name Type
callIndex Uint8Array

Returns: MethodFunction

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

Defined in primitive/Method.ts:181

Parameters:

Name Type
moduleMethods ModulesWithMethods

Returns: void

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_primitive_method_.method.md b/docs/types/classes/_primitive_method_.method.md deleted file mode 100644 index c44036f62c..0000000000 --- a/docs/types/classes/_primitive_method_.method.md +++ /dev/null @@ -1,580 +0,0 @@ - - -*__name__*: Method - -*__description__*: Extrinsic function descriptor, as defined in [https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node](https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node). - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Method** - -↳ [Proposal](_type_proposal_.proposal.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Method**(value: *`any`*, meta?: *[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)*): [Method](_primitive_method_.method.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [primitive/Method.ts:70](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L70)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | -| `Optional` meta | [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) | - -**Returns:** [Method](_primitive_method_.method.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## args - -**get args**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Defined in [primitive/Method.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L192)* - -*__description__*: The arguments for the function call - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## argsDef - -**get argsDef**(): `ArgsDef` - -*Defined in [primitive/Method.ts:200](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L200)* - -*__description__*: Thge argument defintions - -**Returns:** `ArgsDef` - -___ - - -## callIndex - -**get callIndex**(): `Uint8Array` - -*Defined in [primitive/Method.ts:207](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L207)* - -*__description__*: The encoded `[sectionIndex, methodIndex]` identifier - -**Returns:** `Uint8Array` - -___ - - -## data - -**get data**(): `Uint8Array` - -*Defined in [primitive/Method.ts:214](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L214)* - -*__description__*: The encoded data - -**Returns:** `Uint8Array` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## hasOrigin - -**get hasOrigin**(): `boolean` - -*Defined in [primitive/Method.ts:221](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L221)* - -*__description__*: `true` if the `Origin` type is on the method (extrinsic method) - -**Returns:** `boolean` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## meta - -**get meta**(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -*Defined in [primitive/Method.ts:230](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L230)* - -*__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -**Returns:** [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` filterOrigin - -▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> - -*Defined in [primitive/Method.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L140)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` meta | [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) | - -**Returns:** `Array`<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> - -___ - - -## `` findFunction - -▸ **findFunction**(callIndex: *`Uint8Array`*): [MethodFunction](../interfaces/_primitive_method_.methodfunction.md) - -*Defined in [primitive/Method.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L156)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callIndex | `Uint8Array` | - -**Returns:** [MethodFunction](../interfaces/_primitive_method_.methodfunction.md) - -___ - - -## `` injectMethods - -▸ **injectMethods**(moduleMethods: *[ModulesWithMethods](../interfaces/_primitive_method_.moduleswithmethods.md)*): `void` - -*Defined in [primitive/Method.ts:181](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L181)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| moduleMethods | [ModulesWithMethods](../interfaces/_primitive_method_.moduleswithmethods.md) | - -**Returns:** `void` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_primitive_method_.methodindex.html b/docs/types/classes/_primitive_method_.methodindex.html deleted file mode 100644 index e9c9761278..0000000000 --- a/docs/types/classes/_primitive_method_.methodindex.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MethodIndex

description: A wrapper around the [sectionIndex, methodIndex] value that uniquely identifies a method

Hierarchy

↳ U8aFixed

↳ MethodIndex

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new MethodIndex(value?: AnyU8a): MethodIndex

Overrides U8aFixed.constructor

Defined in primitive/Method.ts:57

Parameters:

Name Type
Optional value AnyU8a

Returns: MethodIndex

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_primitive_method_.methodindex.md b/docs/types/classes/_primitive_method_.methodindex.md deleted file mode 100644 index b614fc0373..0000000000 --- a/docs/types/classes/_primitive_method_.methodindex.md +++ /dev/null @@ -1,850 +0,0 @@ - - -*__name__*: MethodIndex - -*__description__*: A wrapper around the `[sectionIndex, methodIndex]` value that uniquely identifies a method - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ MethodIndex** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new MethodIndex**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [MethodIndex](_primitive_method_.methodindex.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/Method.ts:57](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L57)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [MethodIndex](_primitive_method_.methodindex.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_primitive_moment_.moment.html b/docs/types/classes/_primitive_moment_.moment.html deleted file mode 100644 index 3523d2e826..0000000000 --- a/docs/types/classes/_primitive_moment_.moment.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Moment

description: A wrapper around seconds/timestamps. Internally the representation only has second precicion (aligning with Rust), so any numbers passed an/out are always per-second. For any encoding/decoding the 1000 multiplier would be applied to get it in line with JavaScript formats. It extends the base JS Date object and has all the methods available that are applicable to any Date

Hierarchy

Date

↳ Moment

↳ MomentOf

Implements

Constructors

constructor

⊕ new Moment(value?: Moment | Date | AnyNumber): Moment

Defined in primitive/Moment.ts:24

Parameters:

Name Type Default value
Default value value Moment | Date | AnyNumber 0

Returns: Moment

Properties

<Static> Date

● Date: DateConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:907

Accessors

encodedLength

get encodedLength(): number

Defined in primitive/Moment.ts:51

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in primitive/Moment.ts:58

description: Checks if the value is an empty value

Returns: boolean

Methods

bitLength

▸ bitLength(): UIntBitLength

Defined in primitive/Moment.ts:72

description: Returns the number of bits in the value

Returns: UIntBitLength

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in primitive/Moment.ts:65

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toBn

▸ toBn(): BN

Defined in primitive/Moment.ts:79

description: Returns the BN representation of the timestamp

Returns: BN

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in primitive/Moment.ts:86

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Date.toJSON

Defined in primitive/Moment.ts:93

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Defined in primitive/Moment.ts:100

description: Returns the number representation for the timestamp

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Overrides Date.toString

Defined in primitive/Moment.ts:107

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in primitive/Moment.ts:116

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeMoment

▸ decodeMoment(value: Moment | Date | AnyNumber): Date

Defined in primitive/Moment.ts:34

Parameters:

Name Type
value Moment | Date | AnyNumber

Returns: Date

- - - diff --git a/docs/types/classes/_primitive_moment_.moment.md b/docs/types/classes/_primitive_moment_.moment.md deleted file mode 100644 index d0f6f297a1..0000000000 --- a/docs/types/classes/_primitive_moment_.moment.md +++ /dev/null @@ -1,229 +0,0 @@ - - -*__name__*: Moment - -*__description__*: A wrapper around seconds/timestamps. Internally the representation only has second precicion (aligning with Rust), so any numbers passed an/out are always per-second. For any encoding/decoding the 1000 multiplier would be applied to get it in line with JavaScript formats. It extends the base JS `Date` object and has all the methods available that are applicable to any `Date` - -# Hierarchy - - `Date` - -**↳ Moment** - -↳ [MomentOf](_primitive_moment_.momentof.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Moment**(value?: *[Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_primitive_moment_.moment.md) - -*Defined in [primitive/Moment.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L24)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber) | 0 | - -**Returns:** [Moment](_primitive_moment_.moment.md) - -___ - -# Properties - - - -## `` Date - -**● Date**: *`DateConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:907* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [primitive/Moment.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L51)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [primitive/Moment.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L58)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Defined in [primitive/Moment.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L72)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [primitive/Moment.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L65)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Defined in [primitive/Moment.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L79)* - -*__description__*: Returns the BN representation of the timestamp - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [primitive/Moment.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L86)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Overrides Date.toJSON* - -*Defined in [primitive/Moment.ts:93](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L93)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Defined in [primitive/Moment.ts:100](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L100)* - -*__description__*: Returns the number representation for the timestamp - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides Date.toString* - -*Defined in [primitive/Moment.ts:107](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L107)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [primitive/Moment.ts:116](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L116)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeMoment - -▸ **decodeMoment**(value: *[Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber)*): `Date` - -*Defined in [primitive/Moment.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L34)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** `Date` - -___ - diff --git a/docs/types/classes/_primitive_moment_.momentof.html b/docs/types/classes/_primitive_moment_.momentof.html deleted file mode 100644 index 7d27d997b5..0000000000 --- a/docs/types/classes/_primitive_moment_.momentof.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MomentOf

description: The Substrate MomentOf representation as a Moment.

Hierarchy

↳ Moment

↳ MomentOf

Implements

Constructors

constructor

⊕ new MomentOf(value?: Moment | Date | AnyNumber): MomentOf

Inherited from Moment.constructor

Defined in primitive/Moment.ts:24

Parameters:

Name Type Default value
Default value value Moment | Date | AnyNumber 0

Returns: MomentOf

Properties

getVarDate

● getVarDate: function

Inherited from Date.getVarDate

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.scripthost.d.ts:326

Type declaration

▸(): VarDate

Returns: VarDate

Accessors

encodedLength

get encodedLength(): number

Inherited from Moment.encodedLength

Defined in primitive/Moment.ts:51

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Moment.isEmpty

Defined in primitive/Moment.ts:58

description: Checks if the value is an empty value

Returns: boolean

Methods

__@toPrimitive

▸ __@toPrimitive(hint: "default"): string

▸ __@toPrimitive(hint: "string"): string

▸ __@toPrimitive(hint: "number"): number

▸ __@toPrimitive(hint: string): string | number

Inherited from Date.[Symbol.toPrimitive]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:109

Converts a Date object to a string.

Parameters:

Name Type
hint "default"

Returns: string

Inherited from Date.[Symbol.toPrimitive]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:113

Converts a Date object to a string.

Parameters:

Name Type
hint "string"

Returns: string

Inherited from Date.[Symbol.toPrimitive]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:117

Converts a Date object to a number.

Parameters:

Name Type
hint "number"

Returns: number

Inherited from Date.[Symbol.toPrimitive]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:126

Converts a Date object to a string or number.

throws: {TypeError} If 'hint' was given something other than "number", "string", or "default".

Parameters:

Name Type Description
hint string The strings "number", "string", or "default" to specify what primitive to return.

Returns: string | number -A number if 'hint' was "number", a string if 'hint' was "string" or "default".

bitLength

▸ bitLength(): UIntBitLength

Inherited from Moment.bitLength

Defined in primitive/Moment.ts:72

description: Returns the number of bits in the value

Returns: UIntBitLength

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Moment.eq

Defined in primitive/Moment.ts:65

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

getDate

▸ getDate(): number

Inherited from Date.getDate

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:755

Gets the day-of-the-month, using local time.

Returns: number

getDay

▸ getDay(): number

Inherited from Date.getDay

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:759

Gets the day of the week, using local time.

Returns: number

getFullYear

▸ getFullYear(): number

Inherited from Date.getFullYear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:747

Gets the year, using local time.

Returns: number

getHours

▸ getHours(): number

Inherited from Date.getHours

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:763

Gets the hours in a date, using local time.

Returns: number

getMilliseconds

▸ getMilliseconds(): number

Inherited from Date.getMilliseconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:775

Gets the milliseconds of a Date, using local time.

Returns: number

getMinutes

▸ getMinutes(): number

Inherited from Date.getMinutes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:767

Gets the minutes of a Date object, using local time.

Returns: number

getMonth

▸ getMonth(): number

Inherited from Date.getMonth

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:751

Gets the month, using local time.

Returns: number

getSeconds

▸ getSeconds(): number

Inherited from Date.getSeconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:771

Gets the seconds of a Date object, using local time.

Returns: number

getTime

▸ getTime(): number

Inherited from Date.getTime

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:745

Gets the time value in milliseconds.

Returns: number

getTimezoneOffset

▸ getTimezoneOffset(): number

Inherited from Date.getTimezoneOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:779

Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC).

Returns: number

getUTCDate

▸ getUTCDate(): number

Inherited from Date.getUTCDate

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:757

Gets the day-of-the-month, using Universal Coordinated Time (UTC).

Returns: number

getUTCDay

▸ getUTCDay(): number

Inherited from Date.getUTCDay

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:761

Gets the day of the week using Universal Coordinated Time (UTC).

Returns: number

getUTCFullYear

▸ getUTCFullYear(): number

Inherited from Date.getUTCFullYear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:749

Gets the year using Universal Coordinated Time (UTC).

Returns: number

getUTCHours

▸ getUTCHours(): number

Inherited from Date.getUTCHours

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:765

Gets the hours value in a Date object using Universal Coordinated Time (UTC).

Returns: number

getUTCMilliseconds

▸ getUTCMilliseconds(): number

Inherited from Date.getUTCMilliseconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:777

Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).

Returns: number

getUTCMinutes

▸ getUTCMinutes(): number

Inherited from Date.getUTCMinutes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:769

Gets the minutes of a Date object using Universal Coordinated Time (UTC).

Returns: number

getUTCMonth

▸ getUTCMonth(): number

Inherited from Date.getUTCMonth

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:753

Gets the month of a Date object using Universal Coordinated Time (UTC).

Returns: number

getUTCSeconds

▸ getUTCSeconds(): number

Inherited from Date.getUTCSeconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:773

Gets the seconds of a Date object using Universal Coordinated Time (UTC).

Returns: number

setDate

▸ setDate(date: number): number

Inherited from Date.setDate

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:842

Sets the numeric day-of-the-month value of the Date object using local time.

Parameters:

Name Type Description
date number A numeric value equal to the day of the month.

Returns: number

setFullYear

▸ setFullYear(year: number, month?: undefined | number, date?: undefined | number): number

Inherited from Date.setFullYear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:866

Sets the year of the Date object using local time.

Parameters:

Name Type Description
year number A numeric value for the year.
Optional month undefined | number A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified.
Optional date undefined | number A numeric value equal for the day of the month.

Returns: number

setHours

▸ setHours(hours: number, min?: undefined | number, sec?: undefined | number, ms?: undefined | number): number

Inherited from Date.setHours

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:829

Sets the hour value in the Date object using local time.

Parameters:

Name Type Description
hours number A numeric value equal to the hours value.
Optional min undefined | number A numeric value equal to the minutes value.
Optional sec undefined | number A numeric value equal to the seconds value.
Optional ms undefined | number A numeric value equal to the milliseconds value.

Returns: number

setMilliseconds

▸ setMilliseconds(ms: number): number

Inherited from Date.setMilliseconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:789

Sets the milliseconds value in the Date object using local time.

Parameters:

Name Type Description
ms number A numeric value equal to the millisecond value.

Returns: number

setMinutes

▸ setMinutes(min: number, sec?: undefined | number, ms?: undefined | number): number

Inherited from Date.setMinutes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:814

Sets the minutes value in the Date object using local time.

Parameters:

Name Type Description
min number A numeric value equal to the minutes value.
Optional sec undefined | number A numeric value equal to the seconds value.
Optional ms undefined | number A numeric value equal to the milliseconds value.

Returns: number

setMonth

▸ setMonth(month: number, date?: undefined | number): number

Inherited from Date.setMonth

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:853

Sets the month value in the Date object using local time.

Parameters:

Name Type Description
month number A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.
Optional date undefined | number A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used.

Returns: number

setSeconds

▸ setSeconds(sec: number, ms?: undefined | number): number

Inherited from Date.setSeconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:801

Sets the seconds value in the Date object using local time.

Parameters:

Name Type Description
sec number A numeric value equal to the seconds value.
Optional ms undefined | number A numeric value equal to the milliseconds value.

Returns: number

setTime

▸ setTime(time: number): number

Inherited from Date.setTime

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:784

Sets the date and time value in the Date object.

Parameters:

Name Type Description
time number A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT.

Returns: number

setUTCDate

▸ setUTCDate(date: number): number

Inherited from Date.setUTCDate

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:847

Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).

Parameters:

Name Type Description
date number A numeric value equal to the day of the month.

Returns: number

setUTCFullYear

▸ setUTCFullYear(year: number, month?: undefined | number, date?: undefined | number): number

Inherited from Date.setUTCFullYear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:873

Sets the year value in the Date object using Universal Coordinated Time (UTC).

Parameters:

Name Type Description
year number A numeric value equal to the year.
Optional month undefined | number A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied.
Optional date undefined | number A numeric value equal to the day of the month.

Returns: number

setUTCHours

▸ setUTCHours(hours: number, min?: undefined | number, sec?: undefined | number, ms?: undefined | number): number

Inherited from Date.setUTCHours

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:837

Sets the hours value in the Date object using Universal Coordinated Time (UTC).

Parameters:

Name Type Description
hours number A numeric value equal to the hours value.
Optional min undefined | number A numeric value equal to the minutes value.
Optional sec undefined | number A numeric value equal to the seconds value.
Optional ms undefined | number A numeric value equal to the milliseconds value.

Returns: number

setUTCMilliseconds

▸ setUTCMilliseconds(ms: number): number

Inherited from Date.setUTCMilliseconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:794

Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).

Parameters:

Name Type Description
ms number A numeric value equal to the millisecond value.

Returns: number

setUTCMinutes

▸ setUTCMinutes(min: number, sec?: undefined | number, ms?: undefined | number): number

Inherited from Date.setUTCMinutes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:821

Sets the minutes value in the Date object using Universal Coordinated Time (UTC).

Parameters:

Name Type Description
min number A numeric value equal to the minutes value.
Optional sec undefined | number A numeric value equal to the seconds value.
Optional ms undefined | number A numeric value equal to the milliseconds value.

Returns: number

setUTCMonth

▸ setUTCMonth(month: number, date?: undefined | number): number

Inherited from Date.setUTCMonth

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:859

Sets the month value in the Date object using Universal Coordinated Time (UTC).

Parameters:

Name Type Description
month number A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.
Optional date undefined | number A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used.

Returns: number

setUTCSeconds

▸ setUTCSeconds(sec: number, ms?: undefined | number): number

Inherited from Date.setUTCSeconds

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:807

Sets the seconds value in the Date object using Universal Coordinated Time (UTC).

Parameters:

Name Type Description
sec number A numeric value equal to the seconds value.
Optional ms undefined | number A numeric value equal to the milliseconds value.

Returns: number

toBn

▸ toBn(): BN

Inherited from Moment.toBn

Defined in primitive/Moment.ts:79

description: Returns the BN representation of the timestamp

Returns: BN

toDateString

▸ toDateString(): string

Inherited from Date.toDateString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:733

Returns a date as a string value.

Returns: string

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Moment.toHex

Defined in primitive/Moment.ts:86

description: Returns a hex string representation of the value

Returns: string

toISOString

▸ toISOString(): string

Inherited from Date.toISOString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:877

Returns a date as a string value in ISO format.

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Moment.toJSON

Overrides Date.toJSON

Defined in primitive/Moment.ts:93

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleDateString

▸ toLocaleDateString(): string

Inherited from Date.toLocaleDateString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:739

Returns a date as a string value appropriate to the host environment's current locale.

Returns: string

toLocaleString

▸ toLocaleString(): string

Inherited from Date.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:737

Returns a value as a string value appropriate to the host environment's current locale.

Returns: string

toLocaleTimeString

▸ toLocaleTimeString(): string

Inherited from Date.toLocaleTimeString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:741

Returns a time as a string value appropriate to the host environment's current locale.

Returns: string

toNumber

▸ toNumber(): number

Inherited from Moment.toNumber

Defined in primitive/Moment.ts:100

description: Returns the number representation for the timestamp

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Moment.toString

Overrides Date.toString

Defined in primitive/Moment.ts:107

description: Returns the string representation of the value

Returns: string

toTimeString

▸ toTimeString(): string

Inherited from Date.toTimeString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:735

Returns a time as a string value.

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Moment.toU8a

Defined in primitive/Moment.ts:116

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

toUTCString

▸ toUTCString(): string

Inherited from Date.toUTCString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:875

Returns a date converted to a string using Universal Coordinated Time (UTC).

Returns: string

valueOf

▸ valueOf(): number

Inherited from Date.valueOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:743

Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.

Returns: number

<Static> decodeMoment

▸ decodeMoment(value: Moment | Date | AnyNumber): Date

Inherited from Moment.decodeMoment

Defined in primitive/Moment.ts:34

Parameters:

Name Type
value Moment | Date | AnyNumber

Returns: Date

- - - diff --git a/docs/types/classes/_primitive_moment_.momentof.md b/docs/types/classes/_primitive_moment_.momentof.md deleted file mode 100644 index cbe4eb1f94..0000000000 --- a/docs/types/classes/_primitive_moment_.momentof.md +++ /dev/null @@ -1,1053 +0,0 @@ - - -*__name__*: MomentOf - -*__description__*: The Substrate MomentOf representation as a [Moment](_primitive_moment_.moment.md). - -# Hierarchy - -↳ [Moment](_primitive_moment_.moment.md) - -**↳ MomentOf** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MomentOf**(value?: *[Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber)*): [MomentOf](_primitive_moment_.momentof.md) - -*Inherited from [Moment](_primitive_moment_.moment.md).[constructor](_primitive_moment_.moment.md#constructor)* - -*Defined in [primitive/Moment.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L24)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber) | 0 | - -**Returns:** [MomentOf](_primitive_moment_.momentof.md) - -___ - -# Properties - - - -## getVarDate - -**● getVarDate**: *`function`* - -*Inherited from Date.getVarDate* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.scripthost.d.ts:326* - -#### Type declaration -▸(): `VarDate` - -**Returns:** `VarDate` - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Moment](_primitive_moment_.moment.md).[encodedLength](_primitive_moment_.moment.md#encodedlength)* - -*Defined in [primitive/Moment.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L51)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Moment](_primitive_moment_.moment.md).[isEmpty](_primitive_moment_.moment.md#isempty)* - -*Defined in [primitive/Moment.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L58)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@toPrimitive - -▸ **__@toPrimitive**(hint: *"default"*): `string` - -▸ **__@toPrimitive**(hint: *"string"*): `string` - -▸ **__@toPrimitive**(hint: *"number"*): `number` - -▸ **__@toPrimitive**(hint: *`string`*): `string` \| `number` - -*Inherited from Date.[Symbol.toPrimitive]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:109* - -Converts a Date object to a string. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| hint | "default" | - -**Returns:** `string` - -*Inherited from Date.[Symbol.toPrimitive]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:113* - -Converts a Date object to a string. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| hint | "string" | - -**Returns:** `string` - -*Inherited from Date.[Symbol.toPrimitive]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:117* - -Converts a Date object to a number. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| hint | "number" | - -**Returns:** `number` - -*Inherited from Date.[Symbol.toPrimitive]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:126* - -Converts a Date object to a string or number. - -*__throws__*: {TypeError} If 'hint' was given something other than "number", "string", or "default". - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| hint | `string` | The strings "number", "string", or "default" to specify what primitive to return. | - -**Returns:** `string` \| `number` -A number if 'hint' was "number", a string if 'hint' was "string" or "default". - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from [Moment](_primitive_moment_.moment.md).[bitLength](_primitive_moment_.moment.md#bitlength)* - -*Defined in [primitive/Moment.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L72)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Moment](_primitive_moment_.moment.md).[eq](_primitive_moment_.moment.md#eq)* - -*Defined in [primitive/Moment.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L65)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## getDate - -▸ **getDate**(): `number` - -*Inherited from Date.getDate* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:755* - -Gets the day-of-the-month, using local time. - -**Returns:** `number` - -___ - - -## getDay - -▸ **getDay**(): `number` - -*Inherited from Date.getDay* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:759* - -Gets the day of the week, using local time. - -**Returns:** `number` - -___ - - -## getFullYear - -▸ **getFullYear**(): `number` - -*Inherited from Date.getFullYear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:747* - -Gets the year, using local time. - -**Returns:** `number` - -___ - - -## getHours - -▸ **getHours**(): `number` - -*Inherited from Date.getHours* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:763* - -Gets the hours in a date, using local time. - -**Returns:** `number` - -___ - - -## getMilliseconds - -▸ **getMilliseconds**(): `number` - -*Inherited from Date.getMilliseconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:775* - -Gets the milliseconds of a Date, using local time. - -**Returns:** `number` - -___ - - -## getMinutes - -▸ **getMinutes**(): `number` - -*Inherited from Date.getMinutes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:767* - -Gets the minutes of a Date object, using local time. - -**Returns:** `number` - -___ - - -## getMonth - -▸ **getMonth**(): `number` - -*Inherited from Date.getMonth* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:751* - -Gets the month, using local time. - -**Returns:** `number` - -___ - - -## getSeconds - -▸ **getSeconds**(): `number` - -*Inherited from Date.getSeconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:771* - -Gets the seconds of a Date object, using local time. - -**Returns:** `number` - -___ - - -## getTime - -▸ **getTime**(): `number` - -*Inherited from Date.getTime* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:745* - -Gets the time value in milliseconds. - -**Returns:** `number` - -___ - - -## getTimezoneOffset - -▸ **getTimezoneOffset**(): `number` - -*Inherited from Date.getTimezoneOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:779* - -Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCDate - -▸ **getUTCDate**(): `number` - -*Inherited from Date.getUTCDate* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:757* - -Gets the day-of-the-month, using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCDay - -▸ **getUTCDay**(): `number` - -*Inherited from Date.getUTCDay* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:761* - -Gets the day of the week using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCFullYear - -▸ **getUTCFullYear**(): `number` - -*Inherited from Date.getUTCFullYear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:749* - -Gets the year using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCHours - -▸ **getUTCHours**(): `number` - -*Inherited from Date.getUTCHours* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:765* - -Gets the hours value in a Date object using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCMilliseconds - -▸ **getUTCMilliseconds**(): `number` - -*Inherited from Date.getUTCMilliseconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:777* - -Gets the milliseconds of a Date object using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCMinutes - -▸ **getUTCMinutes**(): `number` - -*Inherited from Date.getUTCMinutes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:769* - -Gets the minutes of a Date object using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCMonth - -▸ **getUTCMonth**(): `number` - -*Inherited from Date.getUTCMonth* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:753* - -Gets the month of a Date object using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## getUTCSeconds - -▸ **getUTCSeconds**(): `number` - -*Inherited from Date.getUTCSeconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:773* - -Gets the seconds of a Date object using Universal Coordinated Time (UTC). - -**Returns:** `number` - -___ - - -## setDate - -▸ **setDate**(date: *`number`*): `number` - -*Inherited from Date.setDate* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:842* - -Sets the numeric day-of-the-month value of the Date object using local time. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| date | `number` | A numeric value equal to the day of the month. | - -**Returns:** `number` - -___ - - -## setFullYear - -▸ **setFullYear**(year: *`number`*, month?: *`undefined` \| `number`*, date?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setFullYear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:866* - -Sets the year of the Date object using local time. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| year | `number` | A numeric value for the year. | -| `Optional` month | `undefined` \| `number` | A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified. | -| `Optional` date | `undefined` \| `number` | A numeric value equal for the day of the month. | - -**Returns:** `number` - -___ - - -## setHours - -▸ **setHours**(hours: *`number`*, min?: *`undefined` \| `number`*, sec?: *`undefined` \| `number`*, ms?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setHours* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:829* - -Sets the hour value in the Date object using local time. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| hours | `number` | A numeric value equal to the hours value. | -| `Optional` min | `undefined` \| `number` | A numeric value equal to the minutes value. | -| `Optional` sec | `undefined` \| `number` | A numeric value equal to the seconds value. | -| `Optional` ms | `undefined` \| `number` | A numeric value equal to the milliseconds value. | - -**Returns:** `number` - -___ - - -## setMilliseconds - -▸ **setMilliseconds**(ms: *`number`*): `number` - -*Inherited from Date.setMilliseconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:789* - -Sets the milliseconds value in the Date object using local time. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| ms | `number` | A numeric value equal to the millisecond value. | - -**Returns:** `number` - -___ - - -## setMinutes - -▸ **setMinutes**(min: *`number`*, sec?: *`undefined` \| `number`*, ms?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setMinutes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:814* - -Sets the minutes value in the Date object using local time. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| min | `number` | A numeric value equal to the minutes value. | -| `Optional` sec | `undefined` \| `number` | A numeric value equal to the seconds value. | -| `Optional` ms | `undefined` \| `number` | A numeric value equal to the milliseconds value. | - -**Returns:** `number` - -___ - - -## setMonth - -▸ **setMonth**(month: *`number`*, date?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setMonth* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:853* - -Sets the month value in the Date object using local time. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| month | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. | -| `Optional` date | `undefined` \| `number` | A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used. | - -**Returns:** `number` - -___ - - -## setSeconds - -▸ **setSeconds**(sec: *`number`*, ms?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setSeconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:801* - -Sets the seconds value in the Date object using local time. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| sec | `number` | A numeric value equal to the seconds value. | -| `Optional` ms | `undefined` \| `number` | A numeric value equal to the milliseconds value. | - -**Returns:** `number` - -___ - - -## setTime - -▸ **setTime**(time: *`number`*): `number` - -*Inherited from Date.setTime* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:784* - -Sets the date and time value in the Date object. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| time | `number` | A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT. | - -**Returns:** `number` - -___ - - -## setUTCDate - -▸ **setUTCDate**(date: *`number`*): `number` - -*Inherited from Date.setUTCDate* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:847* - -Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC). - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| date | `number` | A numeric value equal to the day of the month. | - -**Returns:** `number` - -___ - - -## setUTCFullYear - -▸ **setUTCFullYear**(year: *`number`*, month?: *`undefined` \| `number`*, date?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setUTCFullYear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:873* - -Sets the year value in the Date object using Universal Coordinated Time (UTC). - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| year | `number` | A numeric value equal to the year. | -| `Optional` month | `undefined` \| `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied. | -| `Optional` date | `undefined` \| `number` | A numeric value equal to the day of the month. | - -**Returns:** `number` - -___ - - -## setUTCHours - -▸ **setUTCHours**(hours: *`number`*, min?: *`undefined` \| `number`*, sec?: *`undefined` \| `number`*, ms?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setUTCHours* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:837* - -Sets the hours value in the Date object using Universal Coordinated Time (UTC). - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| hours | `number` | A numeric value equal to the hours value. | -| `Optional` min | `undefined` \| `number` | A numeric value equal to the minutes value. | -| `Optional` sec | `undefined` \| `number` | A numeric value equal to the seconds value. | -| `Optional` ms | `undefined` \| `number` | A numeric value equal to the milliseconds value. | - -**Returns:** `number` - -___ - - -## setUTCMilliseconds - -▸ **setUTCMilliseconds**(ms: *`number`*): `number` - -*Inherited from Date.setUTCMilliseconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:794* - -Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC). - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| ms | `number` | A numeric value equal to the millisecond value. | - -**Returns:** `number` - -___ - - -## setUTCMinutes - -▸ **setUTCMinutes**(min: *`number`*, sec?: *`undefined` \| `number`*, ms?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setUTCMinutes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:821* - -Sets the minutes value in the Date object using Universal Coordinated Time (UTC). - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| min | `number` | A numeric value equal to the minutes value. | -| `Optional` sec | `undefined` \| `number` | A numeric value equal to the seconds value. | -| `Optional` ms | `undefined` \| `number` | A numeric value equal to the milliseconds value. | - -**Returns:** `number` - -___ - - -## setUTCMonth - -▸ **setUTCMonth**(month: *`number`*, date?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setUTCMonth* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:859* - -Sets the month value in the Date object using Universal Coordinated Time (UTC). - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| month | `number` | A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. | -| `Optional` date | `undefined` \| `number` | A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used. | - -**Returns:** `number` - -___ - - -## setUTCSeconds - -▸ **setUTCSeconds**(sec: *`number`*, ms?: *`undefined` \| `number`*): `number` - -*Inherited from Date.setUTCSeconds* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:807* - -Sets the seconds value in the Date object using Universal Coordinated Time (UTC). - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| sec | `number` | A numeric value equal to the seconds value. | -| `Optional` ms | `undefined` \| `number` | A numeric value equal to the milliseconds value. | - -**Returns:** `number` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [Moment](_primitive_moment_.moment.md).[toBn](_primitive_moment_.moment.md#tobn)* - -*Defined in [primitive/Moment.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L79)* - -*__description__*: Returns the BN representation of the timestamp - -**Returns:** `BN` - -___ - - -## toDateString - -▸ **toDateString**(): `string` - -*Inherited from Date.toDateString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:733* - -Returns a date as a string value. - -**Returns:** `string` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Moment](_primitive_moment_.moment.md).[toHex](_primitive_moment_.moment.md#tohex)* - -*Defined in [primitive/Moment.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L86)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toISOString - -▸ **toISOString**(): `string` - -*Inherited from Date.toISOString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:877* - -Returns a date as a string value in ISO format. - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Moment](_primitive_moment_.moment.md).[toJSON](_primitive_moment_.moment.md#tojson)* - -*Overrides Date.toJSON* - -*Defined in [primitive/Moment.ts:93](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L93)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleDateString - -▸ **toLocaleDateString**(): `string` - -*Inherited from Date.toLocaleDateString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:739* - -Returns a date as a string value appropriate to the host environment's current locale. - -**Returns:** `string` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Date.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:737* - -Returns a value as a string value appropriate to the host environment's current locale. - -**Returns:** `string` - -___ - - -## toLocaleTimeString - -▸ **toLocaleTimeString**(): `string` - -*Inherited from Date.toLocaleTimeString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:741* - -Returns a time as a string value appropriate to the host environment's current locale. - -**Returns:** `string` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Moment](_primitive_moment_.moment.md).[toNumber](_primitive_moment_.moment.md#tonumber)* - -*Defined in [primitive/Moment.ts:100](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L100)* - -*__description__*: Returns the number representation for the timestamp - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Moment](_primitive_moment_.moment.md).[toString](_primitive_moment_.moment.md#tostring)* - -*Overrides Date.toString* - -*Defined in [primitive/Moment.ts:107](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L107)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toTimeString - -▸ **toTimeString**(): `string` - -*Inherited from Date.toTimeString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:735* - -Returns a time as a string value. - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Moment](_primitive_moment_.moment.md).[toU8a](_primitive_moment_.moment.md#tou8a)* - -*Defined in [primitive/Moment.ts:116](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L116)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## toUTCString - -▸ **toUTCString**(): `string` - -*Inherited from Date.toUTCString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:875* - -Returns a date converted to a string using Universal Coordinated Time (UTC). - -**Returns:** `string` - -___ - - -## valueOf - -▸ **valueOf**(): `number` - -*Inherited from Date.valueOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:743* - -Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. - -**Returns:** `number` - -___ - - -## `` decodeMoment - -▸ **decodeMoment**(value: *[Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber)*): `Date` - -*Inherited from [Moment](_primitive_moment_.moment.md).[decodeMoment](_primitive_moment_.moment.md#decodemoment)* - -*Defined in [primitive/Moment.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Moment.ts#L34)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [Moment](_primitive_moment_.moment.md) \| `Date` \| [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** `Date` - -___ - diff --git a/docs/types/classes/_primitive_null_.null.html b/docs/types/classes/_primitive_null_.null.html deleted file mode 100644 index b268bbf541..0000000000 --- a/docs/types/classes/_primitive_null_.null.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Null

description: Implements a type that does not contain anything (apart from null)

Hierarchy

Null

↳ Default

↳ Optional

↳ Dropped

↳ Future

↳ Ready

↳ Invalid

↳ Finalization

↳ Origin

Implements

Accessors

encodedLength

get encodedLength(): number

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_primitive_null_.null.md b/docs/types/classes/_primitive_null_.null.md deleted file mode 100644 index b275ea8579..0000000000 --- a/docs/types/classes/_primitive_null_.null.md +++ /dev/null @@ -1,149 +0,0 @@ - - -*__name__*: Null - -*__description__*: Implements a type that does not contain anything (apart from `null`) - -# Hierarchy - -**Null** - -↳ [Default](_metadata_v1_storage_.default.md) - -↳ [Optional](_metadata_v1_storage_.optional.md) - -↳ [Dropped](_rpc_extrinsicstatus_.dropped.md) - -↳ [Future](_rpc_extrinsicstatus_.future.md) - -↳ [Ready](_rpc_extrinsicstatus_.ready.md) - -↳ [Invalid](_rpc_extrinsicstatus_.invalid.md) - -↳ [Finalization](_type_eventrecord_.finalization.md) - -↳ [Origin](_type_origin_.origin.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_primitive_storagedata_.storagedata.html b/docs/types/classes/_primitive_storagedata_.storagedata.html deleted file mode 100644 index 63f50fdd43..0000000000 --- a/docs/types/classes/_primitive_storagedata_.storagedata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: StorageData

description: Data retrieved via Storage queries and data for KeyValue pairs

Hierarchy

↳ Bytes

↳ StorageData

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new StorageData(value?: AnyU8a): StorageData

Inherited from Bytes.constructor

Overrides U8a.constructor

Defined in primitive/Bytes.ts:18

Parameters:

Name Type
Optional value AnyU8a

Returns: StorageData

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

Defined in primitive/Bytes.ts:61

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

Defined in primitive/Bytes.ts:69

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_primitive_storagedata_.storagedata.md b/docs/types/classes/_primitive_storagedata_.storagedata.md deleted file mode 100644 index d0ec47e60b..0000000000 --- a/docs/types/classes/_primitive_storagedata_.storagedata.md +++ /dev/null @@ -1,841 +0,0 @@ - - -*__name__*: StorageData - -*__description__*: Data retrieved via Storage queries and data for KeyValue pairs - -# Hierarchy - -↳ [Bytes](_primitive_bytes_.bytes.md) - -**↳ StorageData** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new StorageData**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [StorageData](_primitive_storagedata_.storagedata.md) - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[constructor](_primitive_bytes_.bytes.md#constructor)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [StorageData](_primitive_storagedata_.storagedata.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[encodedLength](_primitive_bytes_.bytes.md#encodedlength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[toU8a](_primitive_bytes_.bytes.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_primitive_storagekey_.storagekey.html b/docs/types/classes/_primitive_storagekey_.storagekey.html deleted file mode 100644 index 2f148f7a24..0000000000 --- a/docs/types/classes/_primitive_storagekey_.storagekey.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: StorageKey

description: A representation of a storage key (typically hashed) in the system. It can be constructed by passing in a raw key or a StorageFunction with (optional) arguments.

Hierarchy

↳ Bytes

↳ StorageKey

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new StorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): StorageKey

Overrides Bytes.constructor

Defined in primitive/StorageKey.ts:28

Parameters:

Name Type
value AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]

Returns: StorageKey

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

Defined in primitive/Bytes.ts:61

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

meta

get meta(): StorageFunctionMetadata | null

Defined in primitive/StorageKey.ts:82

description: The metadata or null when not available

Returns: StorageFunctionMetadata | null

outputType

get outputType(): string | null

Defined in primitive/StorageKey.ts:89

description: The output type, null when not available

Returns: string | null

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

Defined in primitive/Bytes.ts:69

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

<Static> decodeStorageKey

▸ decodeStorageKey(value: AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]): Uint8Array

Defined in primitive/StorageKey.ts:37

Parameters:

Name Type
value AnyU8a | StorageKey | StorageFunction | [StorageFunction, any]

Returns: Uint8Array

<Static> getMeta

▸ getMeta(value: StorageKey | StorageFunction | [StorageFunction, any]): StorageFunctionMetadata | null

Defined in primitive/StorageKey.ts:51

Parameters:

Name Type
value StorageKey | StorageFunction | [StorageFunction, any]

Returns: StorageFunctionMetadata | null

<Static> getType

▸ getType(value: StorageKey | StorageFunction | [StorageFunction, any]): string | null

Defined in primitive/StorageKey.ts:65

Parameters:

Name Type
value StorageKey | StorageFunction | [StorageFunction, any]

Returns: string | null

- - - diff --git a/docs/types/classes/_primitive_storagekey_.storagekey.md b/docs/types/classes/_primitive_storagekey_.storagekey.md deleted file mode 100644 index 4db1babaee..0000000000 --- a/docs/types/classes/_primitive_storagekey_.storagekey.md +++ /dev/null @@ -1,916 +0,0 @@ - - -*__name__*: StorageKey - -*__description__*: A representation of a storage key (typically hashed) in the system. It can be constructed by passing in a raw key or a StorageFunction with (optional) arguments. - -# Hierarchy - -↳ [Bytes](_primitive_bytes_.bytes.md) - -**↳ StorageKey** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new StorageKey**(value: *[AnyU8a](../modules/_types_.md#anyu8a) \| [StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`]*): [StorageKey](_primitive_storagekey_.storagekey.md) - -*Overrides [Bytes](_primitive_bytes_.bytes.md).[constructor](_primitive_bytes_.bytes.md#constructor)* - -*Defined in [primitive/StorageKey.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L28)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyU8a](../modules/_types_.md#anyu8a) \| [StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`] | - -**Returns:** [StorageKey](_primitive_storagekey_.storagekey.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[encodedLength](_primitive_bytes_.bytes.md#encodedlength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - - -## meta - -**get meta**(): [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) \| `null` - -*Defined in [primitive/StorageKey.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L82)* - -*__description__*: The metadata or `null` when not available - -**Returns:** [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) \| `null` - -___ - - -## outputType - -**get outputType**(): `string` \| `null` - -*Defined in [primitive/StorageKey.ts:89](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L89)* - -*__description__*: The output type, `null` when not available - -**Returns:** `string` \| `null` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[toU8a](_primitive_bytes_.bytes.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## `` decodeStorageKey - -▸ **decodeStorageKey**(value: *[AnyU8a](../modules/_types_.md#anyu8a) \| [StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`]*): `Uint8Array` - -*Defined in [primitive/StorageKey.ts:37](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L37)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyU8a](../modules/_types_.md#anyu8a) \| [StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`] | - -**Returns:** `Uint8Array` - -___ - - -## `` getMeta - -▸ **getMeta**(value: *[StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`]*): [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) \| `null` - -*Defined in [primitive/StorageKey.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L51)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`] | - -**Returns:** [StorageFunctionMetadata](_metadata_v0_modules_.storagefunctionmetadata.md) \| `null` - -___ - - -## `` getType - -▸ **getType**(value: *[StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`]*): `string` \| `null` - -*Defined in [primitive/StorageKey.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L65)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [StorageKey](_primitive_storagekey_.storagekey.md) \| [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) \| [[StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md), `any`] | - -**Returns:** `string` \| `null` - -___ - diff --git a/docs/types/classes/_primitive_text_.text.html b/docs/types/classes/_primitive_text_.text.html deleted file mode 100644 index 86855e8c1e..0000000000 --- a/docs/types/classes/_primitive_text_.text.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Text

description: This is a string wrapper, along with the length. It is used both for strings as well as items such as documentation. It simply extends the standard JS String built-in object, inheriting all methods exposed from String.

Hierarchy

String

↳ Text

↳ Type

Implements

Indexable

[index: number]: string

Constructors

constructor

⊕ new Text(value?: Text | string | AnyU8a | object): Text

Defined in primitive/Text.ts:23

Parameters:

Name Type Default value
Default value value Text | string | AnyU8a | object ""

Returns: Text

Properties

<Static> String

● String: StringConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:527

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Accessors

encodedLength

get encodedLength(): number

Defined in primitive/Text.ts:45

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in primitive/Text.ts:52

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Overrides String.length

Defined in primitive/Text.ts:59

description: The length of the value

Returns: number

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in primitive/Text.ts:67

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in primitive/Text.ts:76

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in primitive/Text.ts:83

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Overrides String.toString

Defined in primitive/Text.ts:90

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in primitive/Text.ts:99

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_primitive_text_.text.md b/docs/types/classes/_primitive_text_.text.md deleted file mode 100644 index 99378283cf..0000000000 --- a/docs/types/classes/_primitive_text_.text.md +++ /dev/null @@ -1,191 +0,0 @@ - - -*__name__*: Text - -*__description__*: This is a string wrapper, along with the length. It is used both for strings as well as items such as documentation. It simply extends the standard JS `String` built-in object, inheriting all methods exposed from `String`. - -# Hierarchy - - `String` - -**↳ Text** - -↳ [Type](_primitive_type_.type.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `string` -# Constructors - - - -## constructor - -⊕ **new Text**(value?: *[Text](_primitive_text_.text.md) \| `string` \| [AnyU8a](../modules/_types_.md#anyu8a) \| `object`*): [Text](_primitive_text_.text.md) - -*Defined in [primitive/Text.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L23)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Text](_primitive_text_.text.md) \| `string` \| [AnyU8a](../modules/_types_.md#anyu8a) \| `object` | "" | - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Properties - - - -## `` String - -**● String**: *`StringConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:527* - -Allows manipulation and formatting of text strings and determination and location of substrings within strings. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [primitive/Text.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L45)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L52)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Overrides String.length* - -*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L59)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L67)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L76)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L83)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides String.toString* - -*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L90)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [primitive/Text.ts:99](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L99)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_primitive_type_.type.html b/docs/types/classes/_primitive_type_.type.html deleted file mode 100644 index ea300a5199..0000000000 --- a/docs/types/classes/_primitive_type_.type.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Type

description: This is a extended version of String, specifically to handle types. Here we rely fully on what string provides us, however we also adjust the types received from the runtime, i.e. we remove the T:: prefixes found in some types for consistency accross implementation.

Hierarchy

↳ Text

↳ Type

↳ PlainType

Implements

Indexable

[index: number]: string

Constructors

constructor

⊕ new Type(value?: Text | Uint8Array | string): Type

Overrides Text.constructor

Defined in primitive/Type.ts:19

Parameters:

Name Type Default value
Default value value Text | Uint8Array | string ""

Returns: Type

Accessors

encodedLength

get encodedLength(): number

Overrides Text.encodedLength

Defined in primitive/Type.ts:76

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Text.isEmpty

Defined in primitive/Text.ts:52

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Inherited from Text.length

Overrides String.length

Defined in primitive/Text.ts:59

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<string>

Inherited from String.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:235

Iterator

Returns: IterableIterator<string>

anchor

▸ anchor(name: string): string

Inherited from String.anchor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:454

Returns an HTML anchor element and sets the name attribute to the text value

Parameters:

Name Type Description
name string

Returns: string

big

▸ big(): string

Inherited from String.big

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:457

Returns a HTML element

Returns: string

▸ blink(): string

Inherited from String.blink

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:460

Returns a HTML element

Returns: string

bold

▸ bold(): string

Inherited from String.bold

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:463

Returns a HTML element

Returns: string

charAt

▸ charAt(pos: number): string

Inherited from String.charAt

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:402

Returns the character at the specified index.

Parameters:

Name Type Description
pos number The zero-based index of the desired character.

Returns: string

charCodeAt

▸ charCodeAt(index: number): number

Inherited from String.charCodeAt

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:408

Returns the Unicode value of the character at the specified location.

Parameters:

Name Type Description
index number The zero-based index of the desired character. If there is no character at the specified index, NaN is returned.

Returns: number

codePointAt

▸ codePointAt(pos: number): number | undefined

Inherited from String.codePointAt

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:402

Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.

Parameters:

Name Type
pos number

Returns: number | undefined

concat

▸ concat(...strings: string[]): string

Inherited from String.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:414

Returns a string that contains the concatenation of two or more strings.

Parameters:

Name Type Description
Rest strings string[] The strings to append to the end of the string.

Returns: string

endsWith

▸ endsWith(searchString: string, endPosition?: undefined | number): boolean

Inherited from String.endsWith

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:418

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false.

Parameters:

Name Type
searchString string
Optional endPosition undefined | number

Returns: boolean

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Text.eq

Defined in primitive/Text.ts:67

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

fixed

▸ fixed(): string

Inherited from String.fixed

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:466

Returns a HTML element

Returns: string

fontcolor

▸ fontcolor(color: string): string

Inherited from String.fontcolor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:469

Returns a HTML element and sets the color attribute value

Parameters:

Name Type
color string

Returns: string

fontsize

▸ fontsize(size: number): string

▸ fontsize(size: string): string

Inherited from String.fontsize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:472

Returns a HTML element and sets the size attribute value

Parameters:

Name Type
size number

Returns: string

Inherited from String.fontsize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:475

Returns a HTML element and sets the size attribute value

Parameters:

Name Type
size string

Returns: string

includes

▸ includes(searchString: string, position?: undefined | number): boolean

Inherited from String.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:411

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

Parameters:

Name Type Description
searchString string search string
Optional position undefined | number If position is undefined, 0 is assumed, so as to search all of the String.

Returns: boolean

indexOf

▸ indexOf(searchString: string, position?: undefined | number): number

Inherited from String.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:421

Returns the position of the first occurrence of a substring.

Parameters:

Name Type Description
searchString string The substring to search for in the string
Optional position undefined | number The index at which to begin searching the String object. If omitted, search starts at the beginning of the string.

Returns: number

italics

▸ italics(): string

Inherited from String.italics

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:478

Returns an HTML element

Returns: string

lastIndexOf

▸ lastIndexOf(searchString: string, position?: undefined | number): number

Inherited from String.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:428

Returns the last occurrence of a substring in the string.

Parameters:

Name Type Description
searchString string The substring to search for.
Optional position undefined | number The index at which to begin searching. If omitted, the search begins at the end of the string.

Returns: number

▸ link(url: string): string

Inherited from String.link

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:481

Returns an HTML element and sets the href attribute value

Parameters:

Name Type
url string

Returns: string

localeCompare

▸ localeCompare(that: string): number

Inherited from String.localeCompare

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:434

Determines whether two strings are equivalent in the current locale.

Parameters:

Name Type Description
that string String to compare to target string

Returns: number

match

▸ match(regexp: string | RegExp): RegExpMatchArray | null

Inherited from String.match

Overrides String.match

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:440

Matches a string with a regular expression, and returns an array containing the results of that search.

Parameters:

Name Type Description
regexp string | RegExp A variable name or string literal containing the regular expression pattern and flags.

Returns: RegExpMatchArray | null

normalize

▸ normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string

▸ normalize(form?: undefined | string): string

Inherited from String.normalize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:426

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters:

Name Type Description
form "NFC" | "NFD" | "NFKC" | "NFKD" Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns: string

Inherited from String.normalize

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:434

Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.

Parameters:

Name Type Description
Optional form undefined | string Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC"

Returns: string

padEnd

▸ padEnd(maxLength: number, fillString?: undefined | string): string

Inherited from String.padEnd

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:46

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string.

Parameters:

Name Type Description
maxLength number The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
Optional fillString undefined | string The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns: string

padStart

▸ padStart(maxLength: number, fillString?: undefined | string): string

Inherited from String.padStart

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:33

Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.

Parameters:

Name Type Description
maxLength number The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
Optional fillString undefined | string The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

Returns: string

repeat

▸ repeat(count: number): string

Inherited from String.repeat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:441

Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned.

Parameters:

Name Type Description
count number number of copies to append

Returns: string

replace

▸ replace(searchValue: string | RegExp, replaceValue: string): string

▸ replace(searchValue: string | RegExp, replacer: function): string

Inherited from String.replace

Overrides String.replace

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:447

Replaces text in a string, using a regular expression or search string.

Parameters:

Name Type Description
searchValue string | RegExp A string to search for.
replaceValue string A string containing the text to replace for every successful match of searchValue in this string.

Returns: string

Inherited from String.replace

Overrides String.replace

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:454

Replaces text in a string, using a regular expression or search string.

Parameters:

Name Type Description
searchValue string | RegExp A string to search for.
replacer function A function that returns the replacement text.

Returns: string

▸ search(regexp: string | RegExp): number

Inherited from String.search

Overrides String.search

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:460

Finds the first substring match in a regular expression search.

Parameters:

Name Type Description
regexp string | RegExp The regular expression pattern and applicable flags.

Returns: number

slice

▸ slice(start?: undefined | number, end?: undefined | number): string

Inherited from String.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:468

Returns a section of a string.

Parameters:

Name Type Description
Optional start undefined | number The index to the beginning of the specified portion of stringObj.
Optional end undefined | number The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj.

Returns: string

small

▸ small(): string

Inherited from String.small

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:484

Returns a HTML element

Returns: string

split

▸ split(separator: string | RegExp, limit?: undefined | number): string[]

Inherited from String.split

Overrides String.split

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:475

Split a string into substrings using the specified separator and return them as an array.

Parameters:

Name Type Description
separator string | RegExp A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned.
Optional limit undefined | number A value used to limit the number of elements returned in the array.

Returns: string[]

startsWith

▸ startsWith(searchString: string, position?: undefined | number): boolean

Inherited from String.startsWith

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:448

Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false.

Parameters:

Name Type
searchString string
Optional position undefined | number

Returns: boolean

strike

▸ strike(): string

Inherited from String.strike

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:487

Returns a HTML element

Returns: string

sub

▸ sub(): string

Inherited from String.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:490

Returns a HTML element

Returns: string

substr

▸ substr(from: number, length?: undefined | number): string

Inherited from String.substr

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:509

Gets a substring beginning at the specified location and having the specified length.

Parameters:

Name Type Description
from number The starting position of the desired substring. The index of the first character in the string is zero.
Optional length undefined | number The number of characters to include in the returned substring.

Returns: string

substring

▸ substring(start: number, end?: undefined | number): string

Inherited from String.substring

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:483

Returns the substring at the specified location within a String object.

Parameters:

Name Type Description
start number The zero-based index number indicating the beginning of the substring.
Optional end undefined | number Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned.

Returns: string

sup

▸ sup(): string

Inherited from String.sup

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:493

Returns a HTML element

Returns: string

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Text.toHex

Defined in primitive/Text.ts:76

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Text.toJSON

Defined in primitive/Text.ts:83

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleLowerCase

▸ toLocaleLowerCase(): string

Inherited from String.toLocaleLowerCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:489

Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.

Returns: string

toLocaleUpperCase

▸ toLocaleUpperCase(): string

Inherited from String.toLocaleUpperCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:495

Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.

Returns: string

toLowerCase

▸ toLowerCase(): string

Inherited from String.toLowerCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:486

Converts all the alphabetic characters in a string to lowercase.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Text.toString

Overrides String.toString

Defined in primitive/Text.ts:90

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Overrides Text.toU8a

Defined in primitive/Type.ts:87

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

toUpperCase

▸ toUpperCase(): string

Inherited from String.toUpperCase

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:492

Converts all the alphabetic characters in a string to uppercase.

Returns: string

trim

▸ trim(): string

Inherited from String.trim

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:498

Removes the leading and trailing white space and line terminator characters from a string.

Returns: string

trimLeft

▸ trimLeft(): string

Inherited from String.trimLeft

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:152

Removes whitespace from the left end of a string.

Returns: string

trimRight

▸ trimRight(): string

Inherited from String.trimRight

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:154

Removes whitespace from the right end of a string.

Returns: string

valueOf

▸ valueOf(): string

Inherited from String.valueOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:512

Returns the primitive value of the specified object.

Returns: string

- - - diff --git a/docs/types/classes/_primitive_type_.type.md b/docs/types/classes/_primitive_type_.type.md deleted file mode 100644 index e43c52029b..0000000000 --- a/docs/types/classes/_primitive_type_.type.md +++ /dev/null @@ -1,1061 +0,0 @@ - - -*__name__*: Type - -*__description__*: This is a extended version of String, specifically to handle types. Here we rely fully on what string provides us, however we also adjust the types received from the runtime, i.e. we remove the `T::` prefixes found in some types for consistency accross implementation. - -# Hierarchy - -↳ [Text](_primitive_text_.text.md) - -**↳ Type** - -↳ [PlainType](_metadata_v1_storage_.plaintype.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `string` -# Constructors - - - -## constructor - -⊕ **new Type**(value?: *[Text](_primitive_text_.text.md) \| `Uint8Array` \| `string`*): [Type](_primitive_type_.type.md) - -*Overrides [Text](_primitive_text_.text.md).[constructor](_primitive_text_.text.md#constructor)* - -*Defined in [primitive/Type.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L19)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [Text](_primitive_text_.text.md) \| `Uint8Array` \| `string` | "" | - -**Returns:** [Type](_primitive_type_.type.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Overrides [Text](_primitive_text_.text.md).[encodedLength](_primitive_text_.text.md#encodedlength)* - -*Defined in [primitive/Type.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L76)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Text](_primitive_text_.text.md).[isEmpty](_primitive_text_.text.md#isempty)* - -*Defined in [primitive/Text.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L52)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [Text](_primitive_text_.text.md).[length](_primitive_text_.text.md#length)* - -*Overrides String.length* - -*Defined in [primitive/Text.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L59)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`string`> - -*Inherited from String.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:235* - -Iterator - -**Returns:** `IterableIterator`<`string`> - -___ - - -## anchor - -▸ **anchor**(name: *`string`*): `string` - -*Inherited from String.anchor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:454* - -Returns an HTML anchor element and sets the name attribute to the text value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `string` | | - -**Returns:** `string` - -___ - - -## big - -▸ **big**(): `string` - -*Inherited from String.big* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:457* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## blink - -▸ **blink**(): `string` - -*Inherited from String.blink* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:460* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## bold - -▸ **bold**(): `string` - -*Inherited from String.bold* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:463* - -Returns a **HTML element** - -**Returns:** `string` - -___ - - -## charAt - -▸ **charAt**(pos: *`number`*): `string` - -*Inherited from String.charAt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:402* - -Returns the character at the specified index. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| pos | `number` | The zero-based index of the desired character. | - -**Returns:** `string` - -___ - - -## charCodeAt - -▸ **charCodeAt**(index: *`number`*): `number` - -*Inherited from String.charCodeAt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:408* - -Returns the Unicode value of the character at the specified location. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| index | `number` | The zero-based index of the desired character. If there is no character at the specified index, NaN is returned. | - -**Returns:** `number` - -___ - - -## codePointAt - -▸ **codePointAt**(pos: *`number`*): `number` \| `undefined` - -*Inherited from String.codePointAt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:402* - -Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| pos | `number` | - -**Returns:** `number` \| `undefined` - -___ - - -## concat - -▸ **concat**(...strings: *`string`[]*): `string` - -*Inherited from String.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:414* - -Returns a string that contains the concatenation of two or more strings. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` strings | `string`[] | The strings to append to the end of the string. | - -**Returns:** `string` - -___ - - -## endsWith - -▸ **endsWith**(searchString: *`string`*, endPosition?: *`undefined` \| `number`*): `boolean` - -*Inherited from String.endsWith* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:418* - -Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| searchString | `string` | -| `Optional` endPosition | `undefined` \| `number` | - -**Returns:** `boolean` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Text](_primitive_text_.text.md).[eq](_primitive_text_.text.md#eq)* - -*Defined in [primitive/Text.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L67)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## fixed - -▸ **fixed**(): `string` - -*Inherited from String.fixed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:466* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## fontcolor - -▸ **fontcolor**(color: *`string`*): `string` - -*Inherited from String.fontcolor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:469* - -Returns a HTML element and sets the color attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| color | `string` | - -**Returns:** `string` - -___ - - -## fontsize - -▸ **fontsize**(size: *`number`*): `string` - -▸ **fontsize**(size: *`string`*): `string` - -*Inherited from String.fontsize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:472* - -Returns a HTML element and sets the size attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| size | `number` | - -**Returns:** `string` - -*Inherited from String.fontsize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:475* - -Returns a HTML element and sets the size attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| size | `string` | - -**Returns:** `string` - -___ - - -## includes - -▸ **includes**(searchString: *`string`*, position?: *`undefined` \| `number`*): `boolean` - -*Inherited from String.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:411* - -Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchString | `string` | search string | -| `Optional` position | `undefined` \| `number` | If position is undefined, 0 is assumed, so as to search all of the String. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchString: *`string`*, position?: *`undefined` \| `number`*): `number` - -*Inherited from String.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:421* - -Returns the position of the first occurrence of a substring. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchString | `string` | The substring to search for in the string | -| `Optional` position | `undefined` \| `number` | The index at which to begin searching the String object. If omitted, search starts at the beginning of the string. | - -**Returns:** `number` - -___ - - -## italics - -▸ **italics**(): `string` - -*Inherited from String.italics* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:478* - -Returns an _HTML element_ - -**Returns:** `string` - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchString: *`string`*, position?: *`undefined` \| `number`*): `number` - -*Inherited from String.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:428* - -Returns the last occurrence of a substring in the string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchString | `string` | The substring to search for. | -| `Optional` position | `undefined` \| `number` | The index at which to begin searching. If omitted, the search begins at the end of the string. | - -**Returns:** `number` - -___ - - -## link - -▸ **link**(url: *`string`*): `string` - -*Inherited from String.link* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:481* - -Returns an HTML element and sets the href attribute value - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| url | `string` | - -**Returns:** `string` - -___ - - -## localeCompare - -▸ **localeCompare**(that: *`string`*): `number` - -*Inherited from String.localeCompare* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:434* - -Determines whether two strings are equivalent in the current locale. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| that | `string` | String to compare to target string | - -**Returns:** `number` - -___ - - -## match - -▸ **match**(regexp: *`string` \| `RegExp`*): `RegExpMatchArray` \| `null` - -*Inherited from String.match* - -*Overrides String.match* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:440* - -Matches a string with a regular expression, and returns an array containing the results of that search. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| regexp | `string` \| `RegExp` | A variable name or string literal containing the regular expression pattern and flags. | - -**Returns:** `RegExpMatchArray` \| `null` - -___ - - -## normalize - -▸ **normalize**(form: *"NFC" \| "NFD" \| "NFKC" \| "NFKD"*): `string` - -▸ **normalize**(form?: *`undefined` \| `string`*): `string` - -*Inherited from String.normalize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:426* - -Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| form | "NFC" \| "NFD" \| "NFKC" \| "NFKD" | Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC" | - -**Returns:** `string` - -*Inherited from String.normalize* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:434* - -Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` form | `undefined` \| `string` | Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default is "NFC" | - -**Returns:** `string` - -___ - - -## padEnd - -▸ **padEnd**(maxLength: *`number`*, fillString?: *`undefined` \| `string`*): `string` - -*Inherited from String.padEnd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:46* - -Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| maxLength | `number` | The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is. | -| `Optional` fillString | `undefined` \| `string` | The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020). | - -**Returns:** `string` - -___ - - -## padStart - -▸ **padStart**(maxLength: *`number`*, fillString?: *`undefined` \| `string`*): `string` - -*Inherited from String.padStart* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2017.string.d.ts:33* - -Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| maxLength | `number` | The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is. | -| `Optional` fillString | `undefined` \| `string` | The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020). | - -**Returns:** `string` - -___ - - -## repeat - -▸ **repeat**(count: *`number`*): `string` - -*Inherited from String.repeat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:441* - -Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| count | `number` | number of copies to append | - -**Returns:** `string` - -___ - - -## replace - -▸ **replace**(searchValue: *`string` \| `RegExp`*, replaceValue: *`string`*): `string` - -▸ **replace**(searchValue: *`string` \| `RegExp`*, replacer: *`function`*): `string` - -*Inherited from String.replace* - -*Overrides String.replace* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:447* - -Replaces text in a string, using a regular expression or search string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchValue | `string` \| `RegExp` | A string to search for. | -| replaceValue | `string` | A string containing the text to replace for every successful match of searchValue in this string. | - -**Returns:** `string` - -*Inherited from String.replace* - -*Overrides String.replace* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:454* - -Replaces text in a string, using a regular expression or search string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchValue | `string` \| `RegExp` | A string to search for. | -| replacer | `function` | A function that returns the replacement text. | - -**Returns:** `string` - -___ - - -## search - -▸ **search**(regexp: *`string` \| `RegExp`*): `number` - -*Inherited from String.search* - -*Overrides String.search* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:460* - -Finds the first substring match in a regular expression search. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| regexp | `string` \| `RegExp` | The regular expression pattern and applicable flags. | - -**Returns:** `number` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `string` - -*Inherited from String.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:468* - -Returns a section of a string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The index to the beginning of the specified portion of stringObj. | -| `Optional` end | `undefined` \| `number` | The index to the end of the specified portion of stringObj. The substring includes the characters up to, but not including, the character indicated by end. If this value is not specified, the substring continues to the end of stringObj. | - -**Returns:** `string` - -___ - - -## small - -▸ **small**(): `string` - -*Inherited from String.small* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:484* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## split - -▸ **split**(separator: *`string` \| `RegExp`*, limit?: *`undefined` \| `number`*): `string`[] - -*Inherited from String.split* - -*Overrides String.split* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:475* - -Split a string into substrings using the specified separator and return them as an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| separator | `string` \| `RegExp` | A string that identifies character or characters to use in separating the string. If omitted, a single-element array containing the entire string is returned. | -| `Optional` limit | `undefined` \| `number` | A value used to limit the number of elements returned in the array. | - -**Returns:** `string`[] - -___ - - -## startsWith - -▸ **startsWith**(searchString: *`string`*, position?: *`undefined` \| `number`*): `boolean` - -*Inherited from String.startsWith* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:448* - -Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| searchString | `string` | -| `Optional` position | `undefined` \| `number` | - -**Returns:** `boolean` - -___ - - -## strike - -▸ **strike**(): `string` - -*Inherited from String.strike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:487* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## sub - -▸ **sub**(): `string` - -*Inherited from String.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:490* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## substr - -▸ **substr**(from: *`number`*, length?: *`undefined` \| `number`*): `string` - -*Inherited from String.substr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:509* - -Gets a substring beginning at the specified location and having the specified length. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| from | `number` | The starting position of the desired substring. The index of the first character in the string is zero. | -| `Optional` length | `undefined` \| `number` | The number of characters to include in the returned substring. | - -**Returns:** `string` - -___ - - -## substring - -▸ **substring**(start: *`number`*, end?: *`undefined` \| `number`*): `string` - -*Inherited from String.substring* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:483* - -Returns the substring at the specified location within a String object. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based index number indicating the beginning of the substring. | -| `Optional` end | `undefined` \| `number` | Zero-based index number indicating the end of the substring. The substring includes the characters up to, but not including, the character indicated by end. If end is omitted, the characters from start through the end of the original string are returned. | - -**Returns:** `string` - -___ - - -## sup - -▸ **sup**(): `string` - -*Inherited from String.sup* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:493* - -Returns a HTML element - -**Returns:** `string` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Text](_primitive_text_.text.md).[toHex](_primitive_text_.text.md#tohex)* - -*Defined in [primitive/Text.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L76)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Text](_primitive_text_.text.md).[toJSON](_primitive_text_.text.md#tojson)* - -*Defined in [primitive/Text.ts:83](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L83)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleLowerCase - -▸ **toLocaleLowerCase**(): `string` - -*Inherited from String.toLocaleLowerCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:489* - -Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. - -**Returns:** `string` - -___ - - -## toLocaleUpperCase - -▸ **toLocaleUpperCase**(): `string` - -*Inherited from String.toLocaleUpperCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:495* - -Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale. - -**Returns:** `string` - -___ - - -## toLowerCase - -▸ **toLowerCase**(): `string` - -*Inherited from String.toLowerCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:486* - -Converts all the alphabetic characters in a string to lowercase. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Text](_primitive_text_.text.md).[toString](_primitive_text_.text.md#tostring)* - -*Overrides String.toString* - -*Defined in [primitive/Text.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Text.ts#L90)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Overrides [Text](_primitive_text_.text.md).[toU8a](_primitive_text_.text.md#tou8a)* - -*Defined in [primitive/Type.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Type.ts#L87)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## toUpperCase - -▸ **toUpperCase**(): `string` - -*Inherited from String.toUpperCase* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:492* - -Converts all the alphabetic characters in a string to uppercase. - -**Returns:** `string` - -___ - - -## trim - -▸ **trim**(): `string` - -*Inherited from String.trim* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:498* - -Removes the leading and trailing white space and line terminator characters from a string. - -**Returns:** `string` - -___ - - -## trimLeft - -▸ **trimLeft**(): `string` - -*Inherited from String.trimLeft* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:152* - -Removes whitespace from the left end of a string. - -**Returns:** `string` - -___ - - -## trimRight - -▸ **trimRight**(): `string` - -*Inherited from String.trimRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/node/globals.d.ts:154* - -Removes whitespace from the right end of a string. - -**Returns:** `string` - -___ - - -## valueOf - -▸ **valueOf**(): `string` - -*Inherited from String.valueOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:512* - -Returns the primitive value of the specified object. - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_primitive_u128_.u128.html b/docs/types/classes/_primitive_u128_.u128.html deleted file mode 100644 index 1cdbd6b301..0000000000 --- a/docs/types/classes/_primitive_u128_.u128.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U128

description: An 128-bit unsigned integer

Hierarchy

↳ UInt

↳ U128

↳ Balance

Implements

Constructors

constructor

⊕ new U128(value?: AnyNumber): U128

Overrides UInt.constructor

Defined in primitive/U128.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: U128

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_u128_.u128.md b/docs/types/classes/_primitive_u128_.u128.md deleted file mode 100644 index f5b659fc35..0000000000 --- a/docs/types/classes/_primitive_u128_.u128.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: U128 - -*__description__*: An 128-bit unsigned integer - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U128** - -↳ [Balance](_type_balance_.balance.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new U128**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [U128](_primitive_u128_.u128.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [U128](_primitive_u128_.u128.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_u16_.u16.html b/docs/types/classes/_primitive_u16_.u16.html deleted file mode 100644 index c5690d24b2..0000000000 --- a/docs/types/classes/_primitive_u16_.u16.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U16

description: An 16-bit unsigned integer

Hierarchy

↳ UInt

↳ U16

Implements

Constructors

constructor

⊕ new U16(value?: AnyNumber): U16

Overrides UInt.constructor

Defined in primitive/U16.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: U16

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_u16_.u16.md b/docs/types/classes/_primitive_u16_.u16.md deleted file mode 100644 index 27b64c89dc..0000000000 --- a/docs/types/classes/_primitive_u16_.u16.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: U16 - -*__description__*: An 16-bit unsigned integer - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U16** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new U16**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [U16](_primitive_u16_.u16.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U16.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U16.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [U16](_primitive_u16_.u16.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_u256_.u256.html b/docs/types/classes/_primitive_u256_.u256.html deleted file mode 100644 index e317de90a3..0000000000 --- a/docs/types/classes/_primitive_u256_.u256.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U256

description: An 256-bit unsigned integer

Hierarchy

↳ UInt

↳ U256

Implements

Constructors

constructor

⊕ new U256(value?: AnyNumber): U256

Overrides UInt.constructor

Defined in primitive/U256.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: U256

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_u256_.u256.md b/docs/types/classes/_primitive_u256_.u256.md deleted file mode 100644 index 19650eba15..0000000000 --- a/docs/types/classes/_primitive_u256_.u256.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: U256 - -*__description__*: An 256-bit unsigned integer - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U256** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new U256**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [U256](_primitive_u256_.u256.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U256.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U256.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [U256](_primitive_u256_.u256.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_u32_.u32.html b/docs/types/classes/_primitive_u32_.u32.html deleted file mode 100644 index 1a76e8047e..0000000000 --- a/docs/types/classes/_primitive_u32_.u32.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U32

description: An 32-bit unsigned integer

Hierarchy

↳ UInt

↳ U32

↳ MagicNumber

↳ AccountIndex

↳ ParaId

↳ ApplyExtrinsic

↳ Permill

↳ Perbill

↳ PropIndex

↳ ProposalIndex

↳ ReferendumIndex

↳ VoteIndex

Implements

Constructors

constructor

⊕ new U32(value?: AnyNumber): U32

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: U32

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_u32_.u32.md b/docs/types/classes/_primitive_u32_.u32.md deleted file mode 100644 index 34f1b610aa..0000000000 --- a/docs/types/classes/_primitive_u32_.u32.md +++ /dev/null @@ -1,2046 +0,0 @@ - - -*__name__*: U32 - -*__description__*: An 32-bit unsigned integer - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U32** - -↳ [MagicNumber](_metadata_magicnumber_.magicnumber.md) - -↳ [AccountIndex](_type_accountindex_.accountindex.md) - -↳ [ParaId](_type_paraid_.paraid.md) - -↳ [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) - -↳ [Permill](_type_permill_.permill.md) - -↳ [Perbill](_type_perbill_.perbill.md) - -↳ [PropIndex](_type_propindex_.propindex.md) - -↳ [ProposalIndex](_type_proposalindex_.proposalindex.md) - -↳ [ReferendumIndex](_type_referendumindex_.referendumindex.md) - -↳ [VoteIndex](_type_voteindex_.voteindex.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new U32**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [U32](_primitive_u32_.u32.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_u64_.u64.html b/docs/types/classes/_primitive_u64_.u64.html deleted file mode 100644 index 3668043c0c..0000000000 --- a/docs/types/classes/_primitive_u64_.u64.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U64

description: An 64-bit unsigned integer

Hierarchy

↳ UInt

↳ U64

↳ USize

↳ BlockNumber

↳ Nonce

↳ Gas

Implements

Constructors

constructor

⊕ new U64(value?: AnyNumber): U64

Overrides UInt.constructor

Defined in primitive/U64.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: U64

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_u64_.u64.md b/docs/types/classes/_primitive_u64_.u64.md deleted file mode 100644 index 531431b875..0000000000 --- a/docs/types/classes/_primitive_u64_.u64.md +++ /dev/null @@ -1,2034 +0,0 @@ - - -*__name__*: U64 - -*__description__*: An 64-bit unsigned integer - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U64** - -↳ [USize](_primitive_usize_.usize.md) - -↳ [BlockNumber](_type_blocknumber_.blocknumber.md) - -↳ [Nonce](_type_nonce_.nonce.md) - -↳ [Gas](_type_gas_.gas.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new U64**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [U64](_primitive_u64_.u64.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [U64](_primitive_u64_.u64.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_u8_.u8.html b/docs/types/classes/_primitive_u8_.u8.html deleted file mode 100644 index c7e8d7d931..0000000000 --- a/docs/types/classes/_primitive_u8_.u8.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: U8

description: An 8-bit unsigned integer

Hierarchy

↳ UInt

↳ U8

Implements

Constructors

constructor

⊕ new U8(value?: AnyNumber): U8

Overrides UInt.constructor

Defined in primitive/U8.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: U8

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_u8_.u8.md b/docs/types/classes/_primitive_u8_.u8.md deleted file mode 100644 index 2f43b14106..0000000000 --- a/docs/types/classes/_primitive_u8_.u8.md +++ /dev/null @@ -1,2026 +0,0 @@ - - -*__name__*: U8 - -*__description__*: An 8-bit unsigned integer - -# Hierarchy - -↳ [UInt](_codec_uint_.uint.md) - -**↳ U8** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new U8**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [U8](_primitive_u8_.u8.md) - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U8.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U8.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [U8](_primitive_u8_.u8.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_primitive_usize_.usize.html b/docs/types/classes/_primitive_usize_.usize.html deleted file mode 100644 index 3d0c3ece9e..0000000000 --- a/docs/types/classes/_primitive_usize_.usize.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: USize

description: A System default unsigned number, typically used in RPC to report non-consensus data. It is a wrapper for U64 as a 64-binary default

Hierarchy

↳ U64

↳ USize

Implements

Constructors

constructor

⊕ new USize(value?: AnyNumber): USize

Inherited from U64.constructor

Overrides UInt.constructor

Defined in primitive/U64.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: USize

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_primitive_usize_.usize.md b/docs/types/classes/_primitive_usize_.usize.md deleted file mode 100644 index afdff060b0..0000000000 --- a/docs/types/classes/_primitive_usize_.usize.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: USize - -*__description__*: A System default unsigned number, typically used in RPC to report non-consensus data. It is a wrapper for [U64](_primitive_u64_.u64.md) as a 64-binary default - -# Hierarchy - -↳ [U64](_primitive_u64_.u64.md) - -**↳ USize** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new USize**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [USize](_primitive_usize_.usize.md) - -*Inherited from [U64](_primitive_u64_.u64.md).[constructor](_primitive_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [USize](_primitive_usize_.usize.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_rpc_chainproperties_.chainproperties.html b/docs/types/classes/_rpc_chainproperties_.chainproperties.html deleted file mode 100644 index 1d5a3ed2c3..0000000000 --- a/docs/types/classes/_rpc_chainproperties_.chainproperties.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ChainProperties

description: Wraps the properties retrieved from the chain via the system.properties RPC call.

Hierarchy

↳ Json

↳ ChainProperties

Implements

Constructors

constructor

⊕ new ChainProperties(value?: object | null): ChainProperties

Inherited from Json.constructor

Defined in rpc/Json.ts:16

Parameters:

Name Type
Optional value object | null

Returns: ChainProperties

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

encodedLength

get encodedLength(): number

Inherited from Json.encodedLength

Defined in rpc/Json.ts:28

description: Always 0, never encodes as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Json.isEmpty

Defined in rpc/Json.ts:35

description: Checks if the value is an empty value

Returns: boolean

tokenDecimals

get tokenDecimals(): number | undefined

Defined in rpc/ChainProperties.ts:16

description: The token decimals, if defined (de-facto standard only)

Returns: number | undefined

tokenSymbol

get tokenSymbol(): string | undefined

Defined in rpc/ChainProperties.ts:23

description: The token system, if defined (de-facto standard only)

Returns: string | undefined

Methods

__@iterator

▸ __@iterator(): IterableIterator<[string, any]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[string, any]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: string): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key string

Returns: boolean

entries

▸ entries(): IterableIterator<[string, any]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[string, any]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Json.eq

Defined in rpc/Json.ts:42

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(key: string): any | undefined

Inherited from Map.get

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:25

Parameters:

Name Type
key string

Returns: any | undefined

has

▸ has(key: string): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key string

Returns: boolean

keys

▸ keys(): IterableIterator<string>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<string>

set

▸ set(key: string, value: any): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key string
value any

Returns: this

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Json.toHex

Defined in rpc/Json.ts:49

description: Unimplemented, will throw

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Json.toJSON

Defined in rpc/Json.ts:56

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Json.toString

Defined in rpc/Json.ts:67

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Json.toU8a

Defined in rpc/Json.ts:74

description: Unimplemented, will throw

Parameters:

Name Type
Optional isBare undefined | false | true

Returns: Uint8Array

values

▸ values(): IterableIterator<any>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<any>

- - - diff --git a/docs/types/classes/_rpc_chainproperties_.chainproperties.md b/docs/types/classes/_rpc_chainproperties_.chainproperties.md deleted file mode 100644 index e543781a9e..0000000000 --- a/docs/types/classes/_rpc_chainproperties_.chainproperties.md +++ /dev/null @@ -1,392 +0,0 @@ - - -*__name__*: ChainProperties - -*__description__*: Wraps the properties retrieved from the chain via the `system.properties` RPC call. - -# Hierarchy - -↳ [Json](_rpc_json_.json.md) - -**↳ ChainProperties** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ChainProperties**(value?: *`object` \| `null`*): [ChainProperties](_rpc_chainproperties_.chainproperties.md) - -*Inherited from [Json](_rpc_json_.json.md).[constructor](_rpc_json_.json.md#constructor)* - -*Defined in [rpc/Json.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `object` \| `null` | - -**Returns:** [ChainProperties](_rpc_chainproperties_.chainproperties.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Json](_rpc_json_.json.md).[encodedLength](_rpc_json_.json.md#encodedlength)* - -*Defined in [rpc/Json.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L28)* - -*__description__*: Always 0, never encodes as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Json](_rpc_json_.json.md).[isEmpty](_rpc_json_.json.md#isempty)* - -*Defined in [rpc/Json.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L35)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## tokenDecimals - -**get tokenDecimals**(): `number` \| `undefined` - -*Defined in [rpc/ChainProperties.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ChainProperties.ts#L16)* - -*__description__*: The token decimals, if defined (de-facto standard only) - -**Returns:** `number` \| `undefined` - -___ - - -## tokenSymbol - -**get tokenSymbol**(): `string` \| `undefined` - -*Defined in [rpc/ChainProperties.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ChainProperties.ts#L23)* - -*__description__*: The token system, if defined (de-facto standard only) - -**Returns:** `string` \| `undefined` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`string`, `any`]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`string`, `any`]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`string`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`string`, `any`]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`string`, `any`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Json](_rpc_json_.json.md).[eq](_rpc_json_.json.md#eq)* - -*Defined in [rpc/Json.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L42)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(key: *`string`*): `any` \| `undefined` - -*Inherited from Map.get* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:25* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | - -**Returns:** `any` \| `undefined` - -___ - - -## has - -▸ **has**(key: *`string`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`string`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`string`> - -___ - - -## set - -▸ **set**(key: *`string`*, value: *`any`*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | -| value | `any` | - -**Returns:** `this` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Json](_rpc_json_.json.md).[toHex](_rpc_json_.json.md#tohex)* - -*Defined in [rpc/Json.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L49)* - -*__description__*: Unimplemented, will throw - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Json](_rpc_json_.json.md).[toJSON](_rpc_json_.json.md#tojson)* - -*Defined in [rpc/Json.ts:56](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L56)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Json](_rpc_json_.json.md).[toString](_rpc_json_.json.md#tostring)* - -*Defined in [rpc/Json.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L67)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Json](_rpc_json_.json.md).[toU8a](_rpc_json_.json.md#tou8a)* - -*Defined in [rpc/Json.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L74)* - -*__description__*: Unimplemented, will throw - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`any`> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<`any`> - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.broadcast.html b/docs/types/classes/_rpc_extrinsicstatus_.broadcast.html deleted file mode 100644 index 19a1c18518..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.broadcast.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Broadcast

description: An ExtrinsicStatus indicating that the Extrinsic has been boradcast to peers

Type parameters

T : Codec

Hierarchy

↳ Vector

↳ Broadcast

Implements

Indexable

[n: number]: T

Constructors

constructor

⊕ new Broadcast(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Broadcast

Inherited from Vector.constructor

Defined in codec/Vector.ts:22

Parameters:

Name Type Default value
Type Constructor<T> -
Default value value Vector<any> | Uint8Array | string | Array<any> [] as Array<any>

Returns: Broadcast

Accessors

Type

get Type(): string

Inherited from Vector.Type

Defined in codec/Vector.ts:66

description: The type for the items

Returns: string

encodedLength

get encodedLength(): number

Inherited from Vector.encodedLength

Defined in codec/Vector.ts:73

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Vector.isEmpty

Defined in codec/Vector.ts:59

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Inherited from Vector.length

Overrides Array.length

Defined in codec/Vector.ts:82

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<T>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<T>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<T>[]): T[]

▸ concat(...items: (T | ConcatArray<T>)[]): T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<T>[] Additional items to add to the end of array1.

Returns: T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: T[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, T]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, T]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

Defined in codec/Vector.ts:90

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: T, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value T value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

Defined in codec/Vector.ts:173

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<T>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): T | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : T

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: T | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: T, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement T The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(_other?: any): number

Inherited from Vector.indexOf

Overrides Array.indexOf

Defined in codec/Vector.ts:97

description: Finds the index of the value in the array

Parameters:

Name Type
Optional _other any

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: T, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement T The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

Defined in codec/Vector.ts:182

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): T | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: T | undefined

push

▸ push(...items: T[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items T[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): T

▸ reduce(callbackfn: function, initialValue: T): T

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): T

▸ reduceRight(callbackfn: function, initialValue: T): T

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): T[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: T[]

shift

▸ shift(): T | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: T | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): T[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: T[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): T[]

▸ splice(start: number, deleteCount: number, ...items: T[]): T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items T[] Elements to insert into the array in place of the deleted elements.

Returns: T[]

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

Defined in codec/Vector.ts:115

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

Defined in codec/Vector.ts:122

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

Defined in codec/Vector.ts:129

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

Defined in codec/Vector.ts:138

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Vector.toU8a

Defined in codec/Vector.ts:151

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: T[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items T[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<T>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<T>

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

Name Type
Type Constructor<T>
value Vector<any> | Uint8Array | string | Array<any>

Returns: Array<T>

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

Name Type
Type Constructor<O>

Returns: Constructor<Vector<O>>

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.broadcast.md b/docs/types/classes/_rpc_extrinsicstatus_.broadcast.md deleted file mode 100644 index 1310c27297..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.broadcast.md +++ /dev/null @@ -1,1203 +0,0 @@ - - -*__name__*: Broadcast - -*__description__*: An [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) indicating that the [Extrinsic](_type_extrinsic_.extrinsic.md) has been boradcast to peers - -# Type parameters -#### T : [Codec](../interfaces/_types_.codec.md) -# Hierarchy - -↳ [Vector](_codec_vector_.vector.md) - -**↳ Broadcast** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: `T` -# Constructors - - - -## constructor - -⊕ **new Broadcast**(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): [Broadcast](_rpc_extrinsicstatus_.broadcast.md) - -*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* - -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | [] as Array<any> | - -**Returns:** [Broadcast](_rpc_extrinsicstatus_.broadcast.md) - -___ - -# Accessors - - - -## Type - -**get Type**(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66)* - -*__description__*: The type for the items - -**Returns:** `string` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* - -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* - -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* - -*Overrides Array.length* - -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`T`> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<`T`> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<`T`>[]*): `T`[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<`T`>[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `T`]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `T`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`T`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `T` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<`T`> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `T` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : `T` -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `T` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(_other?: *`any`*): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[indexOf](_codec_vector_.vector.md#indexof)* - -*Overrides Array.indexOf* - -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97)* - -*__description__*: Finds the index of the value in the array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` _other | `any` | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): `T` \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## push - -▸ **push**(...items: *`T`[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `T` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `T` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `T`[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** `T`[] - -___ - - -## shift - -▸ **shift**(): `T` \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `T`[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `T`[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): `T`[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *`T`[]*): `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | `T`[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** `T`[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* - -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`T`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* - -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* - -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* - -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *`T`[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`T`> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<`T`> - -___ - - -## `` decodeVector - -▸ **decodeVector**<`T`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### T : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | - -**Returns:** `Array`<`T`> - -___ - - -## `` with - -▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`O`>*): [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48)* - -**Type parameters:** - -#### O : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`O`> | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.dropped.html b/docs/types/classes/_rpc_extrinsicstatus_.dropped.html deleted file mode 100644 index e9ff2efd89..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.dropped.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Dropped

description: An ExtrinsicStatus indicating that the Extrinsic has been dropped

Hierarchy

Null

↳ Dropped

Implements

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.dropped.md b/docs/types/classes/_rpc_extrinsicstatus_.dropped.md deleted file mode 100644 index 78dbd7bef7..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.dropped.md +++ /dev/null @@ -1,149 +0,0 @@ - - -*__name__*: Dropped - -*__description__*: An [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) indicating that the [Extrinsic](_type_extrinsic_.extrinsic.md) has been dropped - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Dropped** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html b/docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html deleted file mode 100644 index a890f9bb45..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ExtrinsicStatus

description: An EnumType that indicates the status of the Extrinsic as been submitted

Hierarchy

↳ EnumType<Future | Ready | Finalised | Usurped | Broadcast | Dropped | Invalid>

↳ ExtrinsicStatus

Implements

Constructors

constructor

⊕ new ExtrinsicStatus(value: any, index?: undefined | number): ExtrinsicStatus

Overrides EnumType.constructor

Defined in rpc/ExtrinsicStatus.ts:72

Parameters:

Name Type
value any
Optional index undefined | number

Returns: ExtrinsicStatus

Accessors

asBroadcast

get asBroadcast(): Broadcast

Defined in rpc/ExtrinsicStatus.ts:88

description: Returns the item as a Broadcast

Returns: Broadcast

asDropped

get asDropped(): Dropped

Defined in rpc/ExtrinsicStatus.ts:95

description: Returns the item as a Dropped

Returns: Dropped

asFinalised

get asFinalised(): Finalised

Defined in rpc/ExtrinsicStatus.ts:102

description: Returns the item as a Finalised

Returns: Finalised

asFuture

get asFuture(): Future

Defined in rpc/ExtrinsicStatus.ts:109

description: Returns the item as a Future

Returns: Future

asInvalid

get asInvalid(): Invalid

Defined in rpc/ExtrinsicStatus.ts:116

description: Returns the item as a Invalid

Returns: Invalid

asReady

get asReady(): Ready

Defined in rpc/ExtrinsicStatus.ts:123

description: Returns the item as a Ready

Returns: Ready

asUsurped

get asUsurped(): Usurped

Defined in rpc/ExtrinsicStatus.ts:130

description: Returns the item as a Usurped

Returns: Usurped

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.md b/docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.md deleted file mode 100644 index 53e63a223b..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.extrinsicstatus.md +++ /dev/null @@ -1,375 +0,0 @@ - - -*__name__*: ExtrinsicStatus - -*__description__*: An [EnumType](_codec_enumtype_.enumtype.md) that indicates the status of the [Extrinsic](_type_extrinsic_.extrinsic.md) as been submitted - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<[Future](_rpc_extrinsicstatus_.future.md) \| [Ready](_rpc_extrinsicstatus_.ready.md) \| [Finalised](_rpc_extrinsicstatus_.finalised.md) \| [Usurped](_rpc_extrinsicstatus_.usurped.md) \| [Broadcast](_rpc_extrinsicstatus_.broadcast.md) \| [Dropped](_rpc_extrinsicstatus_.dropped.md) \| [Invalid](_rpc_extrinsicstatus_.invalid.md)> - -**↳ ExtrinsicStatus** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ExtrinsicStatus**(value: *`any`*, index?: *`undefined` \| `number`*): [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [rpc/ExtrinsicStatus.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L72)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | -| `Optional` index | `undefined` \| `number` | - -**Returns:** [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) - -___ - -# Accessors - - - -## asBroadcast - -**get asBroadcast**(): [Broadcast](_rpc_extrinsicstatus_.broadcast.md) - -*Defined in [rpc/ExtrinsicStatus.ts:88](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L88)* - -*__description__*: Returns the item as a [Broadcast](_rpc_extrinsicstatus_.broadcast.md) - -**Returns:** [Broadcast](_rpc_extrinsicstatus_.broadcast.md) - -___ - - -## asDropped - -**get asDropped**(): [Dropped](_rpc_extrinsicstatus_.dropped.md) - -*Defined in [rpc/ExtrinsicStatus.ts:95](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L95)* - -*__description__*: Returns the item as a [Dropped](_rpc_extrinsicstatus_.dropped.md) - -**Returns:** [Dropped](_rpc_extrinsicstatus_.dropped.md) - -___ - - -## asFinalised - -**get asFinalised**(): [Finalised](_rpc_extrinsicstatus_.finalised.md) - -*Defined in [rpc/ExtrinsicStatus.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L102)* - -*__description__*: Returns the item as a [Finalised](_rpc_extrinsicstatus_.finalised.md) - -**Returns:** [Finalised](_rpc_extrinsicstatus_.finalised.md) - -___ - - -## asFuture - -**get asFuture**(): [Future](_rpc_extrinsicstatus_.future.md) - -*Defined in [rpc/ExtrinsicStatus.ts:109](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L109)* - -*__description__*: Returns the item as a [Future](_rpc_extrinsicstatus_.future.md) - -**Returns:** [Future](_rpc_extrinsicstatus_.future.md) - -___ - - -## asInvalid - -**get asInvalid**(): [Invalid](_rpc_extrinsicstatus_.invalid.md) - -*Defined in [rpc/ExtrinsicStatus.ts:116](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L116)* - -*__description__*: Returns the item as a [Invalid](_rpc_extrinsicstatus_.invalid.md) - -**Returns:** [Invalid](_rpc_extrinsicstatus_.invalid.md) - -___ - - -## asReady - -**get asReady**(): [Ready](_rpc_extrinsicstatus_.ready.md) - -*Defined in [rpc/ExtrinsicStatus.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L123)* - -*__description__*: Returns the item as a [Ready](_rpc_extrinsicstatus_.ready.md) - -**Returns:** [Ready](_rpc_extrinsicstatus_.ready.md) - -___ - - -## asUsurped - -**get asUsurped**(): [Usurped](_rpc_extrinsicstatus_.usurped.md) - -*Defined in [rpc/ExtrinsicStatus.ts:130](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/ExtrinsicStatus.ts#L130)* - -*__description__*: Returns the item as a [Usurped](_rpc_extrinsicstatus_.usurped.md) - -**Returns:** [Usurped](_rpc_extrinsicstatus_.usurped.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.finalised.html b/docs/types/classes/_rpc_extrinsicstatus_.finalised.html deleted file mode 100644 index 8a66a6228e..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.finalised.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Finalised

description: An [[ExtrinsicStats] indicating that the Extrinsic] has been finalised and included

Hierarchy

↳ Hash

↳ Finalised

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Finalised(value?: AnyU8a): Finalised

Inherited from H256.constructor

Overrides U8aFixed.constructor

Defined in primitive/H256.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: Finalised

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.finalised.md b/docs/types/classes/_rpc_extrinsicstatus_.finalised.md deleted file mode 100644 index 79e37c8cb6..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.finalised.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: Finalised - -*__description__*: An \[\[ExtrinsicStats\] indicating that the [Extrinsic](_type_extrinsic_.extrinsic.md)\] has been finalised and included - -# Hierarchy - -↳ [Hash](_type_hash_.hash.md) - -**↳ Finalised** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Finalised**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Finalised](_rpc_extrinsicstatus_.finalised.md) - -*Inherited from [H256](_primitive_h256_.h256.md).[constructor](_primitive_h256_.h256.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Finalised](_rpc_extrinsicstatus_.finalised.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.future.html b/docs/types/classes/_rpc_extrinsicstatus_.future.html deleted file mode 100644 index 3d2a512e2d..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.future.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Future

description: An ExtrinsicStatus indicating that the Extrinsic has been added to the future queue

Hierarchy

Null

↳ Future

Implements

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.future.md b/docs/types/classes/_rpc_extrinsicstatus_.future.md deleted file mode 100644 index 565bf22f78..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.future.md +++ /dev/null @@ -1,149 +0,0 @@ - - -*__name__*: Future - -*__description__*: An [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) indicating that the [Extrinsic](_type_extrinsic_.extrinsic.md) has been added to the future queue - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Future** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.invalid.html b/docs/types/classes/_rpc_extrinsicstatus_.invalid.html deleted file mode 100644 index 6d1236818f..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.invalid.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Invalid

description: An ExtrinsicStatus indicating that the Extrinsic is invalid

Hierarchy

Null

↳ Invalid

Implements

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.invalid.md b/docs/types/classes/_rpc_extrinsicstatus_.invalid.md deleted file mode 100644 index 535f73f3ab..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.invalid.md +++ /dev/null @@ -1,149 +0,0 @@ - - -*__name__*: Invalid - -*__description__*: An [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) indicating that the [Extrinsic](_type_extrinsic_.extrinsic.md) is invalid - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Invalid** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.ready.html b/docs/types/classes/_rpc_extrinsicstatus_.ready.html deleted file mode 100644 index 9c78be8be3..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.ready.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Ready

description: An ExtrinsicStatus indicating that the Extrinsic has been added to the ready queue

Hierarchy

Null

↳ Ready

Implements

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.ready.md b/docs/types/classes/_rpc_extrinsicstatus_.ready.md deleted file mode 100644 index 45765b9d80..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.ready.md +++ /dev/null @@ -1,149 +0,0 @@ - - -*__name__*: Ready - -*__description__*: An [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) indicating that the [Extrinsic](_type_extrinsic_.extrinsic.md) has been added to the ready queue - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Ready** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.usurped.html b/docs/types/classes/_rpc_extrinsicstatus_.usurped.html deleted file mode 100644 index 0c4451b0a5..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.usurped.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Usurped

description: An ExtrinsicStatus indicating that the Extrinsic has been usurped

Hierarchy

↳ Hash

↳ Usurped

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Usurped(value?: AnyU8a): Usurped

Inherited from H256.constructor

Overrides U8aFixed.constructor

Defined in primitive/H256.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: Usurped

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_rpc_extrinsicstatus_.usurped.md b/docs/types/classes/_rpc_extrinsicstatus_.usurped.md deleted file mode 100644 index 81ee438424..0000000000 --- a/docs/types/classes/_rpc_extrinsicstatus_.usurped.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: Usurped - -*__description__*: An [ExtrinsicStatus](_rpc_extrinsicstatus_.extrinsicstatus.md) indicating that the [Extrinsic](_type_extrinsic_.extrinsic.md) has been usurped - -# Hierarchy - -↳ [Hash](_type_hash_.hash.md) - -**↳ Usurped** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Usurped**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Usurped](_rpc_extrinsicstatus_.usurped.md) - -*Inherited from [H256](_primitive_h256_.h256.md).[constructor](_primitive_h256_.h256.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Usurped](_rpc_extrinsicstatus_.usurped.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_rpc_health_.health.html b/docs/types/classes/_rpc_health_.health.html deleted file mode 100644 index 2446664322..0000000000 --- a/docs/types/classes/_rpc_health_.health.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Health

description: A system health indicator, reported back over RPC

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Health

Implements

Constructors

constructor

⊕ new Health(value?: any): Health

Overrides Struct.constructor

Defined in rpc/Health.ts:19

Parameters:

Name Type
Optional value any

Returns: Health

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

isSyncing

get isSyncing(): Bool

Defined in rpc/Health.ts:31

description: The sync status

Returns: Bool

peers

get peers(): USize

Defined in rpc/Health.ts:38

description: The numbers of peers as U32

Returns: USize

shouldHavePeers

get shouldHavePeers(): Bool

Defined in rpc/Health.ts:45

description: Should this node have peers (not active on --dev)

Returns: Bool

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_rpc_health_.health.md b/docs/types/classes/_rpc_health_.health.md deleted file mode 100644 index c4c5cadbe8..0000000000 --- a/docs/types/classes/_rpc_health_.health.md +++ /dev/null @@ -1,487 +0,0 @@ - - -*__name__*: Health - -*__description__*: A system health indicator, reported back over RPC - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Health** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Health**(value?: *`any`*): [Health](_rpc_health_.health.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [rpc/Health.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L19)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [Health](_rpc_health_.health.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isSyncing - -**get isSyncing**(): [Bool](_primitive_bool_.bool.md) - -*Defined in [rpc/Health.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L31)* - -*__description__*: The sync status - -**Returns:** [Bool](_primitive_bool_.bool.md) - -___ - - -## peers - -**get peers**(): [USize](_primitive_usize_.usize.md) - -*Defined in [rpc/Health.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L38)* - -*__description__*: The numbers of peers as [U32](_primitive_u32_.u32.md) - -**Returns:** [USize](_primitive_usize_.usize.md) - -___ - - -## shouldHavePeers - -**get shouldHavePeers**(): [Bool](_primitive_bool_.bool.md) - -*Defined in [rpc/Health.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Health.ts#L45)* - -*__description__*: Should this node have peers (not active on --dev) - -**Returns:** [Bool](_primitive_bool_.bool.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_rpc_json_.json.html b/docs/types/classes/_rpc_json_.json.html deleted file mode 100644 index 9ee45a18ab..0000000000 --- a/docs/types/classes/_rpc_json_.json.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Json

description: Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it implements a Codec, it is limited in that it can only be used with input objects via RPC, i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys

Hierarchy

Map<string, any>

↳ Json

↳ ChainProperties

↳ NetworkState

Implements

Constructors

constructor

⊕ new Json(value?: object | null): Json

Defined in rpc/Json.ts:16

Parameters:

Name Type
Optional value object | null

Returns: Json

Properties

<Static> Map

● Map: MapConstructor

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36

Accessors

encodedLength

get encodedLength(): number

Defined in rpc/Json.ts:28

description: Always 0, never encodes as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in rpc/Json.ts:35

description: Checks if the value is an empty value

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in rpc/Json.ts:42

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in rpc/Json.ts:49

description: Unimplemented, will throw

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in rpc/Json.ts:56

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Defined in rpc/Json.ts:67

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in rpc/Json.ts:74

description: Unimplemented, will throw

Parameters:

Name Type
Optional isBare undefined | false | true

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_rpc_json_.json.md b/docs/types/classes/_rpc_json_.json.md deleted file mode 100644 index ef3d87ff61..0000000000 --- a/docs/types/classes/_rpc_json_.json.md +++ /dev/null @@ -1,171 +0,0 @@ - - -*__name__*: Json - -*__description__*: Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it implements a Codec, it is limited in that it can only be used with input objects via RPC, i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys - -# Hierarchy - - `Map`<`string`, `any`> - -**↳ Json** - -↳ [ChainProperties](_rpc_chainproperties_.chainproperties.md) - -↳ [NetworkState](_rpc_networkstate_.networkstate.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Json**(value?: *`object` \| `null`*): [Json](_rpc_json_.json.md) - -*Defined in [rpc/Json.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `object` \| `null` | - -**Returns:** [Json](_rpc_json_.json.md) - -___ - -# Properties - - - -## `` Map - -**● Map**: *`MapConstructor`* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [rpc/Json.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L28)* - -*__description__*: Always 0, never encodes as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [rpc/Json.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L35)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [rpc/Json.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L42)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [rpc/Json.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L49)* - -*__description__*: Unimplemented, will throw - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [rpc/Json.ts:56](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L56)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [rpc/Json.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L67)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [rpc/Json.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L74)* - -*__description__*: Unimplemented, will throw - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_rpc_networkstate_.networkstate.html b/docs/types/classes/_rpc_networkstate_.networkstate.html deleted file mode 100644 index 5b4d5fb347..0000000000 --- a/docs/types/classes/_rpc_networkstate_.networkstate.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: NetworkState

description: Wraps the properties retrieved from the chain via the system.network_state RPC call.

Hierarchy

↳ Json

↳ NetworkState

Implements

Constructors

constructor

⊕ new NetworkState(value?: object | null): NetworkState

Inherited from Json.constructor

Defined in rpc/Json.ts:16

Parameters:

Name Type
Optional value object | null

Returns: NetworkState

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

encodedLength

get encodedLength(): number

Inherited from Json.encodedLength

Defined in rpc/Json.ts:28

description: Always 0, never encodes as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Json.isEmpty

Defined in rpc/Json.ts:35

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<[string, any]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[string, any]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: string): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key string

Returns: boolean

entries

▸ entries(): IterableIterator<[string, any]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[string, any]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Json.eq

Defined in rpc/Json.ts:42

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(key: string): any | undefined

Inherited from Map.get

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:25

Parameters:

Name Type
key string

Returns: any | undefined

has

▸ has(key: string): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key string

Returns: boolean

keys

▸ keys(): IterableIterator<string>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<string>

set

▸ set(key: string, value: any): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key string
value any

Returns: this

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Json.toHex

Defined in rpc/Json.ts:49

description: Unimplemented, will throw

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Json.toJSON

Defined in rpc/Json.ts:56

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Json.toString

Defined in rpc/Json.ts:67

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Json.toU8a

Defined in rpc/Json.ts:74

description: Unimplemented, will throw

Parameters:

Name Type
Optional isBare undefined | false | true

Returns: Uint8Array

values

▸ values(): IterableIterator<any>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<any>

- - - diff --git a/docs/types/classes/_rpc_networkstate_.networkstate.md b/docs/types/classes/_rpc_networkstate_.networkstate.md deleted file mode 100644 index c44a6c27a4..0000000000 --- a/docs/types/classes/_rpc_networkstate_.networkstate.md +++ /dev/null @@ -1,366 +0,0 @@ - - -*__name__*: NetworkState - -*__description__*: Wraps the properties retrieved from the chain via the `system.network_state` RPC call. - -# Hierarchy - -↳ [Json](_rpc_json_.json.md) - -**↳ NetworkState** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new NetworkState**(value?: *`object` \| `null`*): [NetworkState](_rpc_networkstate_.networkstate.md) - -*Inherited from [Json](_rpc_json_.json.md).[constructor](_rpc_json_.json.md#constructor)* - -*Defined in [rpc/Json.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `object` \| `null` | - -**Returns:** [NetworkState](_rpc_networkstate_.networkstate.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Json](_rpc_json_.json.md).[encodedLength](_rpc_json_.json.md#encodedlength)* - -*Defined in [rpc/Json.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L28)* - -*__description__*: Always 0, never encodes as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Json](_rpc_json_.json.md).[isEmpty](_rpc_json_.json.md#isempty)* - -*Defined in [rpc/Json.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L35)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`string`, `any`]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`string`, `any`]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`string`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`string`, `any`]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`string`, `any`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Json](_rpc_json_.json.md).[eq](_rpc_json_.json.md#eq)* - -*Defined in [rpc/Json.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L42)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(key: *`string`*): `any` \| `undefined` - -*Inherited from Map.get* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:25* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | - -**Returns:** `any` \| `undefined` - -___ - - -## has - -▸ **has**(key: *`string`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`string`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`string`> - -___ - - -## set - -▸ **set**(key: *`string`*, value: *`any`*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `string` | -| value | `any` | - -**Returns:** `this` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Json](_rpc_json_.json.md).[toHex](_rpc_json_.json.md#tohex)* - -*Defined in [rpc/Json.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L49)* - -*__description__*: Unimplemented, will throw - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Json](_rpc_json_.json.md).[toJSON](_rpc_json_.json.md#tojson)* - -*Defined in [rpc/Json.ts:56](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L56)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Json](_rpc_json_.json.md).[toString](_rpc_json_.json.md#tostring)* - -*Defined in [rpc/Json.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L67)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Json](_rpc_json_.json.md).[toU8a](_rpc_json_.json.md#tou8a)* - -*Defined in [rpc/Json.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/Json.ts#L74)* - -*__description__*: Unimplemented, will throw - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`any`> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<`any`> - -___ - diff --git a/docs/types/classes/_rpc_peerinfo_.peerinfo.html b/docs/types/classes/_rpc_peerinfo_.peerinfo.html deleted file mode 100644 index bb833ab8e3..0000000000 --- a/docs/types/classes/_rpc_peerinfo_.peerinfo.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: PeerInfo

description: A system peer info indicator, reported back over RPC

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ PeerInfo

Implements

Constructors

constructor

⊕ new PeerInfo(value?: any): PeerInfo

Overrides Struct.constructor

Defined in rpc/PeerInfo.ts:24

Parameters:

Name Type
Optional value any

Returns: PeerInfo

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

bestHash

get bestHash(): Hash

Defined in rpc/PeerInfo.ts:39

description: The best block hash for the peer

Returns: Hash

bestNumber

get bestNumber(): BlockNumber

Defined in rpc/PeerInfo.ts:46

description: The best block hash for the peer

Returns: BlockNumber

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): USize

Defined in rpc/PeerInfo.ts:53

description: The index of the peer in our list

Returns: USize

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

peerId

get peerId(): Text

Defined in rpc/PeerInfo.ts:60

description: The p2p network id for the peer

Returns: Text

protocolVersion

get protocolVersion(): U32

Defined in rpc/PeerInfo.ts:67

description: The index of the peer in our list

Returns: U32

roles

get roles(): Text

Defined in rpc/PeerInfo.ts:74

description: The roles of the peer on the network

Returns: Text

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_rpc_peerinfo_.peerinfo.md b/docs/types/classes/_rpc_peerinfo_.peerinfo.md deleted file mode 100644 index d6f1a04b82..0000000000 --- a/docs/types/classes/_rpc_peerinfo_.peerinfo.md +++ /dev/null @@ -1,526 +0,0 @@ - - -*__name__*: PeerInfo - -*__description__*: A system peer info indicator, reported back over RPC - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ PeerInfo** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new PeerInfo**(value?: *`any`*): [PeerInfo](_rpc_peerinfo_.peerinfo.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [rpc/PeerInfo.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L24)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [PeerInfo](_rpc_peerinfo_.peerinfo.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## bestHash - -**get bestHash**(): [Hash](_type_hash_.hash.md) - -*Defined in [rpc/PeerInfo.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L39)* - -*__description__*: The best block hash for the peer - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## bestNumber - -**get bestNumber**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Defined in [rpc/PeerInfo.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L46)* - -*__description__*: The best block hash for the peer - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): [USize](_primitive_usize_.usize.md) - -*Defined in [rpc/PeerInfo.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L53)* - -*__description__*: The index of the peer in our list - -**Returns:** [USize](_primitive_usize_.usize.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## peerId - -**get peerId**(): [Text](_primitive_text_.text.md) - -*Defined in [rpc/PeerInfo.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L60)* - -*__description__*: The p2p network id for the peer - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## protocolVersion - -**get protocolVersion**(): [U32](_primitive_u32_.u32.md) - -*Defined in [rpc/PeerInfo.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L67)* - -*__description__*: The index of the peer in our list - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - - -## roles - -**get roles**(): [Text](_primitive_text_.text.md) - -*Defined in [rpc/PeerInfo.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/PeerInfo.ts#L74)* - -*__description__*: The roles of the peer on the network - -**Returns:** [Text](_primitive_text_.text.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html b/docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html deleted file mode 100644 index aa05090633..0000000000 --- a/docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: PendingExtrinsics

description: A list of pending Extrinsics

Type parameters

T : Codec

Hierarchy

↳ Extrinsics

↳ PendingExtrinsics

Implements

Indexable

[n: number]: T

Constructors

constructor

⊕ new PendingExtrinsics(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): PendingExtrinsics

Inherited from Vector.constructor

Defined in codec/Vector.ts:22

Parameters:

Name Type Default value
Type Constructor<T> -
Default value value Vector<any> | Uint8Array | string | Array<any> [] as Array<any>

Returns: PendingExtrinsics

Accessors

Type

get Type(): string

Inherited from Vector.Type

Defined in codec/Vector.ts:66

description: The type for the items

Returns: string

encodedLength

get encodedLength(): number

Inherited from Vector.encodedLength

Defined in codec/Vector.ts:73

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Vector.isEmpty

Defined in codec/Vector.ts:59

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Inherited from Vector.length

Overrides Array.length

Defined in codec/Vector.ts:82

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<T>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<T>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<T>[]): T[]

▸ concat(...items: (T | ConcatArray<T>)[]): T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<T>[] Additional items to add to the end of array1.

Returns: T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: T[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, T]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, T]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

Defined in codec/Vector.ts:90

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: T, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value T value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

Defined in codec/Vector.ts:173

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<T>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): T | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : T

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: T | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: T, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement T The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(_other?: any): number

Inherited from Vector.indexOf

Overrides Array.indexOf

Defined in codec/Vector.ts:97

description: Finds the index of the value in the array

Parameters:

Name Type
Optional _other any

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: T, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement T The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

Defined in codec/Vector.ts:182

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): T | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: T | undefined

push

▸ push(...items: T[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items T[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): T

▸ reduce(callbackfn: function, initialValue: T): T

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): T

▸ reduceRight(callbackfn: function, initialValue: T): T

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): T[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: T[]

shift

▸ shift(): T | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: T | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): T[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: T[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): T[]

▸ splice(start: number, deleteCount: number, ...items: T[]): T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items T[] Elements to insert into the array in place of the deleted elements.

Returns: T[]

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

Defined in codec/Vector.ts:115

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

Defined in codec/Vector.ts:122

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

Defined in codec/Vector.ts:129

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

Defined in codec/Vector.ts:138

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Vector.toU8a

Defined in codec/Vector.ts:151

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: T[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items T[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<T>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<T>

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

Name Type
Type Constructor<T>
value Vector<any> | Uint8Array | string | Array<any>

Returns: Array<T>

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

Name Type
Type Constructor<O>

Returns: Constructor<Vector<O>>

- - - diff --git a/docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.md b/docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.md deleted file mode 100644 index e9ce816bb0..0000000000 --- a/docs/types/classes/_rpc_pendingextrinsics_.pendingextrinsics.md +++ /dev/null @@ -1,1203 +0,0 @@ - - -*__name__*: PendingExtrinsics - -*__description__*: A list of pending [Extrinsics](_type_extrinsics_.extrinsics.md) - -# Type parameters -#### T : [Codec](../interfaces/_types_.codec.md) -# Hierarchy - -↳ [Extrinsics](_type_extrinsics_.extrinsics.md) - -**↳ PendingExtrinsics** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: `T` -# Constructors - - - -## constructor - -⊕ **new PendingExtrinsics**(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): [PendingExtrinsics](_rpc_pendingextrinsics_.pendingextrinsics.md) - -*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* - -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | [] as Array<any> | - -**Returns:** [PendingExtrinsics](_rpc_pendingextrinsics_.pendingextrinsics.md) - -___ - -# Accessors - - - -## Type - -**get Type**(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66)* - -*__description__*: The type for the items - -**Returns:** `string` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* - -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* - -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* - -*Overrides Array.length* - -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`T`> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<`T`> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<`T`>[]*): `T`[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<`T`>[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `T`]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `T`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`T`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `T` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<`T`> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `T` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : `T` -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `T` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(_other?: *`any`*): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[indexOf](_codec_vector_.vector.md#indexof)* - -*Overrides Array.indexOf* - -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97)* - -*__description__*: Finds the index of the value in the array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` _other | `any` | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): `T` \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## push - -▸ **push**(...items: *`T`[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `T` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `T` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `T`[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** `T`[] - -___ - - -## shift - -▸ **shift**(): `T` \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `T`[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `T`[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): `T`[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *`T`[]*): `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | `T`[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** `T`[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* - -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`T`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* - -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* - -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* - -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *`T`[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`T`> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<`T`> - -___ - - -## `` decodeVector - -▸ **decodeVector**<`T`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### T : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | - -**Returns:** `Array`<`T`> - -___ - - -## `` with - -▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`O`>*): [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48)* - -**Type parameters:** - -#### O : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`O`> | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -___ - diff --git a/docs/types/classes/_rpc_runtimeversion_.apiid.html b/docs/types/classes/_rpc_runtimeversion_.apiid.html deleted file mode 100644 index 7771e3f0eb..0000000000 --- a/docs/types/classes/_rpc_runtimeversion_.apiid.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ApiId

description: An identifier for the runtime API

Hierarchy

↳ U8aFixed

↳ ApiId

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new ApiId(value?: AnyU8a): ApiId

Overrides U8aFixed.constructor

Defined in rpc/RuntimeVersion.ts:19

Parameters:

Name Type
Optional value AnyU8a

Returns: ApiId

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_rpc_runtimeversion_.apiid.md b/docs/types/classes/_rpc_runtimeversion_.apiid.md deleted file mode 100644 index 2e336397cc..0000000000 --- a/docs/types/classes/_rpc_runtimeversion_.apiid.md +++ /dev/null @@ -1,850 +0,0 @@ - - -*__name__*: ApiId - -*__description__*: An identifier for the runtime API - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ ApiId** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new ApiId**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [ApiId](_rpc_runtimeversion_.apiid.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [rpc/RuntimeVersion.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L19)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [ApiId](_rpc_runtimeversion_.apiid.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_rpc_runtimeversion_.runtimeversion.html b/docs/types/classes/_rpc_runtimeversion_.runtimeversion.html deleted file mode 100644 index a953aeaa68..0000000000 --- a/docs/types/classes/_rpc_runtimeversion_.runtimeversion.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: RuntimeVersion

description: A defintion of the runtime and the associated versions thereof

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ RuntimeVersion

Implements

Constructors

constructor

⊕ new RuntimeVersion(value?: RuntimeVersionValue | Uint8Array): RuntimeVersion

Overrides Struct.constructor

Defined in rpc/RuntimeVersion.ts:72

Parameters:

Name Type
Optional value RuntimeVersionValue | Uint8Array

Returns: RuntimeVersion

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

apis

get apis(): Vector<RuntimeVersionApi>

Defined in rpc/RuntimeVersion.ts:93

description: The available APIs as RuntimeVersionApi

Returns: Vector<RuntimeVersionApi>

authoringVersion

get authoringVersion(): U32

Defined in rpc/RuntimeVersion.ts:100

description: The authoring version as U32

Returns: U32

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

implName

get implName(): Text

Defined in rpc/RuntimeVersion.ts:107

description: The implementation name

Returns: Text

implVersion

get implVersion(): U32

Defined in rpc/RuntimeVersion.ts:114

description: The implementation version

Returns: U32

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

specName

get specName(): Text

Defined in rpc/RuntimeVersion.ts:121

description: The specification name

Returns: Text

specVersion

get specVersion(): U32

Defined in rpc/RuntimeVersion.ts:128

description: The specification version

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_rpc_runtimeversion_.runtimeversion.md b/docs/types/classes/_rpc_runtimeversion_.runtimeversion.md deleted file mode 100644 index ca7433e2a7..0000000000 --- a/docs/types/classes/_rpc_runtimeversion_.runtimeversion.md +++ /dev/null @@ -1,527 +0,0 @@ - - -*__name__*: RuntimeVersion - -*__description__*: A defintion of the runtime and the associated versions thereof - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ RuntimeVersion** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) -* [RuntimeVersionInterface](../interfaces/_types_.runtimeversioninterface.md) - -# Constructors - - - -## constructor - -⊕ **new RuntimeVersion**(value?: *`RuntimeVersionValue` \| `Uint8Array`*): [RuntimeVersion](_rpc_runtimeversion_.runtimeversion.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [rpc/RuntimeVersion.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L72)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `RuntimeVersionValue` \| `Uint8Array` | - -**Returns:** [RuntimeVersion](_rpc_runtimeversion_.runtimeversion.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## apis - -**get apis**(): [Vector](_codec_vector_.vector.md)<[RuntimeVersionApi](_rpc_runtimeversion_.runtimeversionapi.md)> - -*Defined in [rpc/RuntimeVersion.ts:93](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L93)* - -*__description__*: The available APIs as [RuntimeVersionApi](_rpc_runtimeversion_.runtimeversionapi.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[RuntimeVersionApi](_rpc_runtimeversion_.runtimeversionapi.md)> - -___ - - -## authoringVersion - -**get authoringVersion**(): [U32](_primitive_u32_.u32.md) - -*Defined in [rpc/RuntimeVersion.ts:100](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L100)* - -*__description__*: The authoring version as [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## implName - -**get implName**(): [Text](_primitive_text_.text.md) - -*Defined in [rpc/RuntimeVersion.ts:107](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L107)* - -*__description__*: The implementation name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## implVersion - -**get implVersion**(): [U32](_primitive_u32_.u32.md) - -*Defined in [rpc/RuntimeVersion.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L114)* - -*__description__*: The implementation version - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## specName - -**get specName**(): [Text](_primitive_text_.text.md) - -*Defined in [rpc/RuntimeVersion.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L121)* - -*__description__*: The specification name - -**Returns:** [Text](_primitive_text_.text.md) - -___ - - -## specVersion - -**get specVersion**(): [U32](_primitive_u32_.u32.md) - -*Defined in [rpc/RuntimeVersion.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L128)* - -*__description__*: The specification version - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.html b/docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.html deleted file mode 100644 index 30269e5d1c..0000000000 --- a/docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: RuntimeVersionApi

description: A Tuple that conatins the ApiId and U32 version

Hierarchy

↳ Tuple

↳ RuntimeVersionApi

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new RuntimeVersionApi(value?: RuntimeVersionApiValue | Uint8Array): RuntimeVersionApi

Overrides Tuple.constructor

Defined in rpc/RuntimeVersion.ts:35

Parameters:

Name Type
Optional value RuntimeVersionApiValue | Uint8Array

Returns: RuntimeVersionApi

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

id

get id(): ApiId

Defined in rpc/RuntimeVersion.ts:46

description: The ApiId

Returns: ApiId

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

version

get version(): U32

Defined in rpc/RuntimeVersion.ts:53

description: The specific version as U32

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.md b/docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.md deleted file mode 100644 index 9657c8b3bb..0000000000 --- a/docs/types/classes/_rpc_runtimeversion_.runtimeversionapi.md +++ /dev/null @@ -1,1198 +0,0 @@ - - -*__name__*: RuntimeVersionApi - -*__description__*: A [Tuple](_codec_tuple_.tuple.md) that conatins the [ApiId](_rpc_runtimeversion_.apiid.md) and [U32](_primitive_u32_.u32.md) version - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ RuntimeVersionApi** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new RuntimeVersionApi**(value?: *`RuntimeVersionApiValue` \| `Uint8Array`*): [RuntimeVersionApi](_rpc_runtimeversion_.runtimeversionapi.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [rpc/RuntimeVersion.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L35)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `RuntimeVersionApiValue` \| `Uint8Array` | - -**Returns:** [RuntimeVersionApi](_rpc_runtimeversion_.runtimeversionapi.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## id - -**get id**(): [ApiId](_rpc_runtimeversion_.apiid.md) - -*Defined in [rpc/RuntimeVersion.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L46)* - -*__description__*: The [ApiId](_rpc_runtimeversion_.apiid.md) - -**Returns:** [ApiId](_rpc_runtimeversion_.apiid.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## version - -**get version**(): [U32](_primitive_u32_.u32.md) - -*Defined in [rpc/RuntimeVersion.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/RuntimeVersion.ts#L53)* - -*__description__*: The specific version as [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_rpc_signedblock_.signedblock.html b/docs/types/classes/_rpc_signedblock_.signedblock.html deleted file mode 100644 index 6f2f07e6e7..0000000000 --- a/docs/types/classes/_rpc_signedblock_.signedblock.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: SignedBlock

description: A Block that has been signed and contains a Justification

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ SignedBlock

Implements

Constructors

constructor

⊕ new SignedBlock(value?: SignedBlockValue | Uint8Array): SignedBlock

Overrides Struct.constructor

Defined in rpc/SignedBlock.ts:22

Parameters:

Name Type
Optional value SignedBlockValue | Uint8Array

Returns: SignedBlock

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

block

get block(): Block

Defined in rpc/SignedBlock.ts:33

description: The wrapped Block

Returns: Block

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

hash

get hash(): Hash

Defined in rpc/SignedBlock.ts:40

description: Block/header Hash

Returns: Hash

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

justification

get justification(): Justification

Defined in rpc/SignedBlock.ts:47

description: The wrapped Justification

Returns: Justification

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_rpc_signedblock_.signedblock.md b/docs/types/classes/_rpc_signedblock_.signedblock.md deleted file mode 100644 index 09fb67ee24..0000000000 --- a/docs/types/classes/_rpc_signedblock_.signedblock.md +++ /dev/null @@ -1,487 +0,0 @@ - - -*__name__*: SignedBlock - -*__description__*: A [Block](_type_block_.block.md) that has been signed and contains a [Justification](_type_justification_.justification.md) - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ SignedBlock** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new SignedBlock**(value?: *`SignedBlockValue` \| `Uint8Array`*): [SignedBlock](_rpc_signedblock_.signedblock.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [rpc/SignedBlock.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `SignedBlockValue` \| `Uint8Array` | - -**Returns:** [SignedBlock](_rpc_signedblock_.signedblock.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## block - -**get block**(): [Block](_type_block_.block.md) - -*Defined in [rpc/SignedBlock.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L33)* - -*__description__*: The wrapped [Block](_type_block_.block.md) - -**Returns:** [Block](_type_block_.block.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## hash - -**get hash**(): [Hash](_type_hash_.hash.md) - -*Defined in [rpc/SignedBlock.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L40)* - -*__description__*: Block/header [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## justification - -**get justification**(): [Justification](_type_justification_.justification.md) - -*Defined in [rpc/SignedBlock.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/SignedBlock.ts#L47)* - -*__description__*: The wrapped [Justification](_type_justification_.justification.md) - -**Returns:** [Justification](_type_justification_.justification.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_rpc_storagechangeset_.storagechangeset.html b/docs/types/classes/_rpc_storagechangeset_.storagechangeset.html deleted file mode 100644 index 627a64e1dd..0000000000 --- a/docs/types/classes/_rpc_storagechangeset_.storagechangeset.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: StorageChangeSet

description: A set of storage changes. It contains the Block hash and a list of the actual changes that took place as an array of KeyValueOption

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ StorageChangeSet

Implements

Constructors

constructor

⊕ new StorageChangeSet(value?: StorageChangeSetValue | Uint8Array): StorageChangeSet

Overrides Struct.constructor

Defined in rpc/StorageChangeSet.ts:24

Parameters:

Name Type
Optional value StorageChangeSetValue | Uint8Array

Returns: StorageChangeSet

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

block

get block(): Hash

Defined in rpc/StorageChangeSet.ts:42

description: The block Hash

Returns: Hash

changes

get changes(): Vector<KeyValueOption>

Defined in rpc/StorageChangeSet.ts:35

description: The applicable changes as KeyValueOption

Returns: Vector<KeyValueOption>

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_rpc_storagechangeset_.storagechangeset.md b/docs/types/classes/_rpc_storagechangeset_.storagechangeset.md deleted file mode 100644 index 4b1aec6a05..0000000000 --- a/docs/types/classes/_rpc_storagechangeset_.storagechangeset.md +++ /dev/null @@ -1,474 +0,0 @@ - - -*__name__*: StorageChangeSet - -*__description__*: A set of storage changes. It contains the [Block](_type_block_.block.md) hash and a list of the actual changes that took place as an array of [KeyValueOption](_type_keyvalue_.keyvalueoption.md) - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StorageChangeSet** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new StorageChangeSet**(value?: *`StorageChangeSetValue` \| `Uint8Array`*): [StorageChangeSet](_rpc_storagechangeset_.storagechangeset.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [rpc/StorageChangeSet.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/StorageChangeSet.ts#L24)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `StorageChangeSetValue` \| `Uint8Array` | - -**Returns:** [StorageChangeSet](_rpc_storagechangeset_.storagechangeset.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## block - -**get block**(): [Hash](_type_hash_.hash.md) - -*Defined in [rpc/StorageChangeSet.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/StorageChangeSet.ts#L42)* - -*__description__*: The block [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## changes - -**get changes**(): [Vector](_codec_vector_.vector.md)<[KeyValueOption](_type_keyvalue_.keyvalueoption.md)> - -*Defined in [rpc/StorageChangeSet.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/rpc/StorageChangeSet.ts#L35)* - -*__description__*: The applicable changes as [KeyValueOption](_type_keyvalue_.keyvalueoption.md) - -**Returns:** [Vector](_codec_vector_.vector.md)<[KeyValueOption](_type_keyvalue_.keyvalueoption.md)> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_accountid_.accountid.html b/docs/types/classes/_type_accountid_.accountid.html deleted file mode 100644 index 3998756ecb..0000000000 --- a/docs/types/classes/_type_accountid_.accountid.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: AccountId

description: A wrapper around an AccountId/PublicKey representation. Since we are dealing with underlying PublicKeys (32 bytes in length), we extend from U8aFixed which is just a Uint8Array wrapper with a fixed length.

Hierarchy

↳ U8aFixed

↳ AccountId

↳ AccountIdOf

↳ AuthorityId

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new AccountId(value?: AnyU8a): AccountId

Overrides U8aFixed.constructor

Defined in type/AccountId.ts:19

Parameters:

Name Type Default value
Default value value AnyU8a new Uint8Array()

Returns: AccountId

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Overrides U8a.eq

Defined in type/AccountId.ts:46

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides U8a.toJSON

Defined in type/AccountId.ts:53

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Overrides U8a.toString

Defined in type/AccountId.ts:60

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

<Static> encode

▸ encode(value: Uint8Array): string

Defined in type/AccountId.ts:27

Parameters:

Name Type
value Uint8Array

Returns: string

- - - diff --git a/docs/types/classes/_type_accountid_.accountid.md b/docs/types/classes/_type_accountid_.accountid.md deleted file mode 100644 index a17ba787b2..0000000000 --- a/docs/types/classes/_type_accountid_.accountid.md +++ /dev/null @@ -1,869 +0,0 @@ - - -*__name__*: AccountId - -*__description__*: A wrapper around an AccountId/PublicKey representation. Since we are dealing with underlying PublicKeys (32 bytes in length), we extend from U8aFixed which is just a Uint8Array wrapper with a fixed length. - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ AccountId** - -↳ [AccountIdOf](_type_accountid_.accountidof.md) - -↳ [AuthorityId](_type_authorityid_.authorityid.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new AccountId**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [AccountId](_type_accountid_.accountid.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_.md#anyu8a) | new Uint8Array() | - -**Returns:** [AccountId](_type_accountid_.accountid.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## `` encode - -▸ **encode**(value: *`Uint8Array`*): `string` - -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `Uint8Array` | - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_type_accountid_.accountidof.html b/docs/types/classes/_type_accountid_.accountidof.html deleted file mode 100644 index 9a87b82876..0000000000 --- a/docs/types/classes/_type_accountid_.accountidof.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: AccountIdOf

description: The Substrate AccountIdOf representation as a AccountId.

Hierarchy

↳ AccountId

↳ AccountIdOf

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new AccountIdOf(value?: AnyU8a): AccountIdOf

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

Defined in type/AccountId.ts:19

Parameters:

Name Type Default value
Default value value AnyU8a new Uint8Array()

Returns: AccountIdOf

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AccountId.eq

Overrides U8a.eq

Defined in type/AccountId.ts:46

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

Defined in type/AccountId.ts:53

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

Defined in type/AccountId.ts:60

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

Defined in type/AccountId.ts:27

Parameters:

Name Type
value Uint8Array

Returns: string

- - - diff --git a/docs/types/classes/_type_accountid_.accountidof.md b/docs/types/classes/_type_accountid_.accountidof.md deleted file mode 100644 index 7eb09c5c4a..0000000000 --- a/docs/types/classes/_type_accountid_.accountidof.md +++ /dev/null @@ -1,875 +0,0 @@ - - -*__name__*: AccountIdOf - -*__description__*: The Substrate AccountIdOf representation as a [AccountId](_type_accountid_.accountid.md). - -# Hierarchy - -↳ [AccountId](_type_accountid_.accountid.md) - -**↳ AccountIdOf** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new AccountIdOf**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [AccountIdOf](_type_accountid_.accountidof.md) - -*Inherited from [AccountId](_type_accountid_.accountid.md).[constructor](_type_accountid_.accountid.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_.md#anyu8a) | new Uint8Array() | - -**Returns:** [AccountIdOf](_type_accountid_.accountidof.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[eq](_type_accountid_.accountid.md#eq)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[toJSON](_type_accountid_.accountid.md#tojson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[toString](_type_accountid_.accountid.md#tostring)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## `` encode - -▸ **encode**(value: *`Uint8Array`*): `string` - -*Inherited from [AccountId](_type_accountid_.accountid.md).[encode](_type_accountid_.accountid.md#encode)* - -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `Uint8Array` | - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_type_accountindex_.accountindex.html b/docs/types/classes/_type_accountindex_.accountindex.html deleted file mode 100644 index 5c781de70a..0000000000 --- a/docs/types/classes/_type_accountindex_.accountindex.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: AccountIndex

description: A wrapper around an AccountIndex, which is a shortened, variable-length encoding for an Account. We extends from U32 to provide the number-like properties.

Hierarchy

↳ U32

↳ AccountIndex

Implements

Constructors

constructor

⊕ new AccountIndex(value?: AnyNumber): AccountIndex

Overrides U32.constructor

Defined in type/AccountIndex.ts:28

Parameters:

Name Type Default value
Default value value AnyNumber new BN(0)

Returns: AccountIndex

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Overrides AbstractInt.eq

Defined in type/AccountIndex.ts:87

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides AbstractInt.toJSON

Defined in type/AccountIndex.ts:100

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(): string

Implementation of Codec.toString

Overrides AbstractInt.toString

Defined in type/AccountIndex.ts:107

description: Returns the string representation of the value

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> calcLength

▸ calcLength(_value: BN | number): number

Defined in type/AccountIndex.ts:47

Parameters:

Name Type
_value BN | number

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> decodeAccountIndex

▸ decodeAccountIndex(value: AnyNumber): BN | Uint8Array | number | string

Defined in type/AccountIndex.ts:35

Parameters:

Name Type
value AnyNumber

Returns: BN | Uint8Array | number | string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> readLength

▸ readLength(input: Uint8Array): [number, number]

Defined in type/AccountIndex.ts:61

Parameters:

Name Type
input Uint8Array

Returns: [number, number]

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

<Static> writeLength

▸ writeLength(input: Uint8Array): Uint8Array

Defined in type/AccountIndex.ts:75

Parameters:

Name Type
input Uint8Array

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_type_accountindex_.accountindex.md b/docs/types/classes/_type_accountindex_.accountindex.md deleted file mode 100644 index 89e53704a8..0000000000 --- a/docs/types/classes/_type_accountindex_.accountindex.md +++ /dev/null @@ -1,2084 +0,0 @@ - - -*__name__*: AccountIndex - -*__description__*: A wrapper around an AccountIndex, which is a shortened, variable-length encoding for an Account. We extends from [U32](_primitive_u32_.u32.md) to provide the number-like properties. - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ AccountIndex** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new AccountIndex**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [AccountIndex](_type_accountindex_.accountindex.md) - -*Overrides [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Defined in [type/AccountIndex.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L28)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyNumber](../modules/_types_.md#anynumber) | new BN(0) | - -**Returns:** [AccountIndex](_type_accountindex_.accountindex.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Overrides AbstractInt.eq* - -*Defined in [type/AccountIndex.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L87)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Overrides AbstractInt.toJSON* - -*Defined in [type/AccountIndex.ts:100](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L100)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Overrides AbstractInt.toString* - -*Defined in [type/AccountIndex.ts:107](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L107)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` calcLength - -▸ **calcLength**(_value: *`BN` \| `number`*): `number` - -*Defined in [type/AccountIndex.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L47)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| _value | `BN` \| `number` | - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` decodeAccountIndex - -▸ **decodeAccountIndex**(value: *[AnyNumber](../modules/_types_.md#anynumber)*): `BN` \| `Uint8Array` \| `number` \| `string` - -*Defined in [type/AccountIndex.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L35)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** `BN` \| `Uint8Array` \| `number` \| `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` readLength - -▸ **readLength**(input: *`Uint8Array`*): [`number`, `number`] - -*Defined in [type/AccountIndex.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L61)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** [`number`, `number`] - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - - -## `` writeLength - -▸ **writeLength**(input: *`Uint8Array`*): `Uint8Array` - -*Defined in [type/AccountIndex.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L75)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| input | `Uint8Array` | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_type_address_.address.html b/docs/types/classes/_type_address_.address.html deleted file mode 100644 index e3fbcbc139..0000000000 --- a/docs/types/classes/_type_address_.address.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Address

description: A wrapper around an AccountId and/or AccountIndex that is encoded with a prefix. Since we are dealing with underlying publicKeys (or shorter encoded addresses), we extend from Base with an AccountId/AccountIndex wrapper. Basically the Address is encoded as [ <prefix-byte>, ...publicKey/...bytes ] as per spec

Hierarchy

Base<AccountId | AccountIndex>

↳ Address

Implements

Constructors

constructor

⊕ new Address(value?: AnyAddress): Address

Overrides Base.constructor

Defined in type/Address.ts:26

Parameters:

Name Type Default value
Default value value AnyAddress new Uint8Array()

Returns: Address

Accessors

encodedLength

get encodedLength(): number

Defined in type/Address.ts:68

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Defined in type/Address.ts:82

description: Checks if the value is an empty value

Returns: boolean

rawLength

get rawLength(): number

Defined in type/Address.ts:89

description: The length of the raw value, either AccountIndex or AccountId

Returns: number

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Defined in type/Address.ts:98

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Defined in type/Address.ts:105

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Defined in type/Address.ts:112

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Defined in type/Address.ts:119

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Defined in type/Address.ts:127

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeAddress

▸ decodeAddress(value: AnyAddress): AccountId | AccountIndex

Defined in type/Address.ts:33

Parameters:

Name Type
value AnyAddress

Returns: AccountId | AccountIndex

- - - diff --git a/docs/types/classes/_type_address_.address.md b/docs/types/classes/_type_address_.address.md deleted file mode 100644 index 745d5fb1c0..0000000000 --- a/docs/types/classes/_type_address_.address.md +++ /dev/null @@ -1,187 +0,0 @@ - - -*__name__*: Address - -*__description__*: A wrapper around an AccountId and/or AccountIndex that is encoded with a prefix. Since we are dealing with underlying publicKeys (or shorter encoded addresses), we extend from Base with an AccountId/AccountIndex wrapper. Basically the Address is encoded as `[ , ...publicKey/...bytes ]` as per spec - -# Hierarchy - - [Base](_codec_base_.base.md)<[AccountId](_type_accountid_.accountid.md) \| [AccountIndex](_type_accountindex_.accountindex.md)> - -**↳ Address** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Address**(value?: *`AnyAddress`*): [Address](_type_address_.address.md) - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [type/Address.ts:26](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L26)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | `AnyAddress` | new Uint8Array() | - -**Returns:** [Address](_type_address_.address.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Defined in [type/Address.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L68)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Defined in [type/Address.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L82)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## rawLength - -**get rawLength**(): `number` - -*Defined in [type/Address.ts:89](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L89)* - -*__description__*: The length of the raw value, either AccountIndex or AccountId - -**Returns:** `number` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Defined in [type/Address.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L98)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Defined in [type/Address.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L105)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Defined in [type/Address.ts:112](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L112)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Defined in [type/Address.ts:119](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L119)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Defined in [type/Address.ts:127](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L127)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeAddress - -▸ **decodeAddress**(value: *`AnyAddress`*): [AccountId](_type_accountid_.accountid.md) \| [AccountIndex](_type_accountindex_.accountindex.md) - -*Defined in [type/Address.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L33)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `AnyAddress` | - -**Returns:** [AccountId](_type_accountid_.accountid.md) \| [AccountIndex](_type_accountindex_.accountindex.md) - -___ - diff --git a/docs/types/classes/_type_amount_.amount.html b/docs/types/classes/_type_amount_.amount.html deleted file mode 100644 index 7bf4b243b6..0000000000 --- a/docs/types/classes/_type_amount_.amount.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Amount

description: The Substrate Amount representation as a Balance.

Hierarchy

↳ Balance

↳ Amount

Implements

Constructors

constructor

⊕ new Amount(value?: AnyNumber): Amount

Inherited from U128.constructor

Overrides UInt.constructor

Defined in primitive/U128.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: Amount

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_amount_.amount.md b/docs/types/classes/_type_amount_.amount.md deleted file mode 100644 index 6993f1d072..0000000000 --- a/docs/types/classes/_type_amount_.amount.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: Amount - -*__description__*: The Substrate Amount representation as a [Balance](_type_balance_.balance.md). - -# Hierarchy - -↳ [Balance](_type_balance_.balance.md) - -**↳ Amount** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Amount**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [Amount](_type_amount_.amount.md) - -*Inherited from [U128](_primitive_u128_.u128.md).[constructor](_primitive_u128_.u128.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Amount](_type_amount_.amount.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_assetof_.assetof.html b/docs/types/classes/_type_assetof_.assetof.html deleted file mode 100644 index cf83965115..0000000000 --- a/docs/types/classes/_type_assetof_.assetof.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: AssetOf

description: The Substrate AssetOf representation as a Balance.

Hierarchy

↳ Balance

↳ AssetOf

Implements

Constructors

constructor

⊕ new AssetOf(value?: AnyNumber): AssetOf

Inherited from U128.constructor

Overrides UInt.constructor

Defined in primitive/U128.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: AssetOf

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_assetof_.assetof.md b/docs/types/classes/_type_assetof_.assetof.md deleted file mode 100644 index 8635121ac3..0000000000 --- a/docs/types/classes/_type_assetof_.assetof.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: AssetOf - -*__description__*: The Substrate AssetOf representation as a [Balance](_type_balance_.balance.md). - -# Hierarchy - -↳ [Balance](_type_balance_.balance.md) - -**↳ AssetOf** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new AssetOf**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [AssetOf](_type_assetof_.assetof.md) - -*Inherited from [U128](_primitive_u128_.u128.md).[constructor](_primitive_u128_.u128.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [AssetOf](_type_assetof_.assetof.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.attestedcandidate.html b/docs/types/classes/_type_attestedcandidate_.attestedcandidate.html deleted file mode 100644 index a4ac21ee2f..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.attestedcandidate.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: AttestedCandidate

description: An attested candidate

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ AttestedCandidate

Implements

Constructors

constructor

⊕ new AttestedCandidate(value?: any): AttestedCandidate

Overrides Struct.constructor

Defined in type/AttestedCandidate.ts:88

Parameters:

Name Type
Optional value any

Returns: AttestedCandidate

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.attestedcandidate.md b/docs/types/classes/_type_attestedcandidate_.attestedcandidate.md deleted file mode 100644 index 9db40ade76..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.attestedcandidate.md +++ /dev/null @@ -1,448 +0,0 @@ - - -*__name__*: AttestedCandidate - -*__description__*: An attested candidate - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ AttestedCandidate** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new AttestedCandidate**(value?: *`any`*): [AttestedCandidate](_type_attestedcandidate_.attestedcandidate.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/AttestedCandidate.ts:88](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L88)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [AttestedCandidate](_type_attestedcandidate_.attestedcandidate.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.availabilityvote.html b/docs/types/classes/_type_attestedcandidate_.availabilityvote.html deleted file mode 100644 index 87b6aa477a..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.availabilityvote.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Tuple

↳ AvailabilityVote

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new AvailabilityVote(Types: TupleConstructors, value: any): AvailabilityVote

Inherited from Tuple.constructor

Defined in codec/Tuple.ts:22

Parameters:

Name Type
Types TupleConstructors
value any

Returns: AvailabilityVote

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.availabilityvote.md b/docs/types/classes/_type_attestedcandidate_.availabilityvote.md deleted file mode 100644 index 82c2cdee80..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.availabilityvote.md +++ /dev/null @@ -1,1169 +0,0 @@ - - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ AvailabilityVote** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new AvailabilityVote**(Types: *`TupleConstructors`*, value: *`any`*): [AvailabilityVote](_type_attestedcandidate_.availabilityvote.md) - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | -| value | `any` | - -**Returns:** [AvailabilityVote](_type_attestedcandidate_.availabilityvote.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.balanceupload.html b/docs/types/classes/_type_attestedcandidate_.balanceupload.html deleted file mode 100644 index 36de67221c..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.balanceupload.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Tuple

↳ BalanceUpload

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new BalanceUpload(Types: TupleConstructors, value: any): BalanceUpload

Inherited from Tuple.constructor

Defined in codec/Tuple.ts:22

Parameters:

Name Type
Types TupleConstructors
value any

Returns: BalanceUpload

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.balanceupload.md b/docs/types/classes/_type_attestedcandidate_.balanceupload.md deleted file mode 100644 index 121e98fa00..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.balanceupload.md +++ /dev/null @@ -1,1169 +0,0 @@ - - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ BalanceUpload** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new BalanceUpload**(Types: *`TupleConstructors`*, value: *`any`*): [BalanceUpload](_type_attestedcandidate_.balanceupload.md) - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | -| value | `any` | - -**Returns:** [BalanceUpload](_type_attestedcandidate_.balanceupload.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.candidatereceipt.html b/docs/types/classes/_type_attestedcandidate_.candidatereceipt.html deleted file mode 100644 index 74bf3ef442..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.candidatereceipt.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - -
polkadot-js/api

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ CandidateReceipt

Implements

Constructors

constructor

⊕ new CandidateReceipt(value?: any): CandidateReceipt

Overrides Struct.constructor

Defined in type/AttestedCandidate.ts:30

Parameters:

Name Type
Optional value any

Returns: CandidateReceipt

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.candidatereceipt.md b/docs/types/classes/_type_attestedcandidate_.candidatereceipt.md deleted file mode 100644 index ef6f3faf98..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.candidatereceipt.md +++ /dev/null @@ -1,444 +0,0 @@ - - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ CandidateReceipt** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new CandidateReceipt**(value?: *`any`*): [CandidateReceipt](_type_attestedcandidate_.candidatereceipt.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/AttestedCandidate.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L30)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [CandidateReceipt](_type_attestedcandidate_.candidatereceipt.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.candidatesignature.html b/docs/types/classes/_type_attestedcandidate_.candidatesignature.html deleted file mode 100644 index e63c3a40e0..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.candidatesignature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Signature

↳ CandidateSignature

↳ ExplicitCandidateSignature

↳ ImplicitCandidateSignature

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new CandidateSignature(value?: AnyU8a): CandidateSignature

Inherited from H512.constructor

Overrides U8aFixed.constructor

Defined in primitive/H512.ts:14

Parameters:

Name Type
Optional value AnyU8a

Returns: CandidateSignature

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.candidatesignature.md b/docs/types/classes/_type_attestedcandidate_.candidatesignature.md deleted file mode 100644 index 153fb3b72a..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.candidatesignature.md +++ /dev/null @@ -1,852 +0,0 @@ - - -# Hierarchy - -↳ [Signature](_type_signature_.signature.md) - -**↳ CandidateSignature** - -↳ [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) - -↳ [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new CandidateSignature**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [CandidateSignature](_type_attestedcandidate_.candidatesignature.md) - -*Inherited from [H512](_primitive_h512_.h512.md).[constructor](_primitive_h512_.h512.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [CandidateSignature](_type_attestedcandidate_.candidatesignature.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.egressqueueroot.html b/docs/types/classes/_type_attestedcandidate_.egressqueueroot.html deleted file mode 100644 index ae7e9fe730..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.egressqueueroot.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Tuple

↳ EgressQueueRoot

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new EgressQueueRoot(Types: TupleConstructors, value: any): EgressQueueRoot

Inherited from Tuple.constructor

Defined in codec/Tuple.ts:22

Parameters:

Name Type
Types TupleConstructors
value any

Returns: EgressQueueRoot

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.egressqueueroot.md b/docs/types/classes/_type_attestedcandidate_.egressqueueroot.md deleted file mode 100644 index 6297c4993b..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.egressqueueroot.md +++ /dev/null @@ -1,1169 +0,0 @@ - - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ EgressQueueRoot** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new EgressQueueRoot**(Types: *`TupleConstructors`*, value: *`any`*): [EgressQueueRoot](_type_attestedcandidate_.egressqueueroot.md) - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | -| value | `any` | - -**Returns:** [EgressQueueRoot](_type_attestedcandidate_.egressqueueroot.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html b/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html deleted file mode 100644 index af3574f421..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ CandidateSignature

↳ ExplicitCandidateSignature

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new ExplicitCandidateSignature(value?: AnyU8a): ExplicitCandidateSignature

Inherited from H512.constructor

Overrides U8aFixed.constructor

Defined in primitive/H512.ts:14

Parameters:

Name Type
Optional value AnyU8a

Returns: ExplicitCandidateSignature

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md b/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md deleted file mode 100644 index c7442e0ab5..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.explicitcandidatesignature.md +++ /dev/null @@ -1,848 +0,0 @@ - - -# Hierarchy - -↳ [CandidateSignature](_type_attestedcandidate_.candidatesignature.md) - -**↳ ExplicitCandidateSignature** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new ExplicitCandidateSignature**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) - -*Inherited from [H512](_primitive_h512_.h512.md).[constructor](_primitive_h512_.h512.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.headdata.html b/docs/types/classes/_type_attestedcandidate_.headdata.html deleted file mode 100644 index e3b6c945e8..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.headdata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Bytes

↳ HeadData

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new HeadData(value?: AnyU8a): HeadData

Inherited from Bytes.constructor

Overrides U8a.constructor

Defined in primitive/Bytes.ts:18

Parameters:

Name Type
Optional value AnyU8a

Returns: HeadData

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

Defined in primitive/Bytes.ts:61

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

Defined in primitive/Bytes.ts:69

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.headdata.md b/docs/types/classes/_type_attestedcandidate_.headdata.md deleted file mode 100644 index 3963417970..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.headdata.md +++ /dev/null @@ -1,837 +0,0 @@ - - -# Hierarchy - -↳ [Bytes](_primitive_bytes_.bytes.md) - -**↳ HeadData** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new HeadData**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [HeadData](_type_attestedcandidate_.headdata.md) - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[constructor](_primitive_bytes_.bytes.md#constructor)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [HeadData](_type_attestedcandidate_.headdata.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[encodedLength](_primitive_bytes_.bytes.md#encodedlength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[toU8a](_primitive_bytes_.bytes.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html b/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html deleted file mode 100644 index e0c60294df..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ CandidateSignature

↳ ImplicitCandidateSignature

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new ImplicitCandidateSignature(value?: AnyU8a): ImplicitCandidateSignature

Inherited from H512.constructor

Overrides U8aFixed.constructor

Defined in primitive/H512.ts:14

Parameters:

Name Type
Optional value AnyU8a

Returns: ImplicitCandidateSignature

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md b/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md deleted file mode 100644 index dcc63582d3..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.implicitcandidatesignature.md +++ /dev/null @@ -1,848 +0,0 @@ - - -# Hierarchy - -↳ [CandidateSignature](_type_attestedcandidate_.candidatesignature.md) - -**↳ ImplicitCandidateSignature** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new ImplicitCandidateSignature**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) - -*Inherited from [H512](_primitive_h512_.h512.md).[constructor](_primitive_h512_.h512.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.validityattestation.html b/docs/types/classes/_type_attestedcandidate_.validityattestation.html deleted file mode 100644 index cfb66d36f6..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.validityattestation.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ EnumType<Null | ImplicitCandidateSignature | ExplicitCandidateSignature>

↳ ValidityAttestation

Implements

Constructors

constructor

⊕ new ValidityAttestation(value?: any): ValidityAttestation

Overrides EnumType.constructor

Defined in type/AttestedCandidate.ts:54

Parameters:

Name Type
Optional value any

Returns: ValidityAttestation

Accessors

asExplicitCandidateSignature

get asExplicitCandidateSignature(): ExplicitCandidateSignature

Defined in type/AttestedCandidate.ts:68

description: Returns the item as a ExplicitCandidateSignature

Returns: ExplicitCandidateSignature

asImplicitCandidateSignature

get asImplicitCandidateSignature(): ImplicitCandidateSignature

Defined in type/AttestedCandidate.ts:75

description: Returns the item as a ImplicitCandidateSignature

Returns: ImplicitCandidateSignature

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.validityattestation.md b/docs/types/classes/_type_attestedcandidate_.validityattestation.md deleted file mode 100644 index af900a3ae2..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.validityattestation.md +++ /dev/null @@ -1,305 +0,0 @@ - - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<[Null](_primitive_null_.null.md) \| [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) \| [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md)> - -**↳ ValidityAttestation** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ValidityAttestation**(value?: *`any`*): [ValidityAttestation](_type_attestedcandidate_.validityattestation.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [type/AttestedCandidate.ts:54](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L54)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [ValidityAttestation](_type_attestedcandidate_.validityattestation.md) - -___ - -# Accessors - - - -## asExplicitCandidateSignature - -**get asExplicitCandidateSignature**(): [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) - -*Defined in [type/AttestedCandidate.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L68)* - -*__description__*: Returns the item as a [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) - -**Returns:** [ExplicitCandidateSignature](_type_attestedcandidate_.explicitcandidatesignature.md) - -___ - - -## asImplicitCandidateSignature - -**get asImplicitCandidateSignature**(): [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) - -*Defined in [type/AttestedCandidate.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AttestedCandidate.ts#L75)* - -*__description__*: Returns the item as a [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) - -**Returns:** [ImplicitCandidateSignature](_type_attestedcandidate_.implicitcandidatesignature.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_attestedcandidate_.validityvote.html b/docs/types/classes/_type_attestedcandidate_.validityvote.html deleted file mode 100644 index b343340c39..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.validityvote.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ Tuple

↳ ValidityVote

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new ValidityVote(Types: TupleConstructors, value: any): ValidityVote

Inherited from Tuple.constructor

Defined in codec/Tuple.ts:22

Parameters:

Name Type
Types TupleConstructors
value any

Returns: ValidityVote

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_attestedcandidate_.validityvote.md b/docs/types/classes/_type_attestedcandidate_.validityvote.md deleted file mode 100644 index acf56fdb03..0000000000 --- a/docs/types/classes/_type_attestedcandidate_.validityvote.md +++ /dev/null @@ -1,1169 +0,0 @@ - - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ ValidityVote** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new ValidityVote**(Types: *`TupleConstructors`*, value: *`any`*): [ValidityVote](_type_attestedcandidate_.validityvote.md) - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | -| value | `any` | - -**Returns:** [ValidityVote](_type_attestedcandidate_.validityvote.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_authorityid_.authorityid.html b/docs/types/classes/_type_authorityid_.authorityid.html deleted file mode 100644 index 42dcfa13fd..0000000000 --- a/docs/types/classes/_type_authorityid_.authorityid.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - -
polkadot-js/api

Hierarchy

↳ AccountId

↳ AuthorityId

↳ SessionKey

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new AuthorityId(value?: AnyU8a): AuthorityId

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

Defined in type/AccountId.ts:19

Parameters:

Name Type Default value
Default value value AnyU8a new Uint8Array()

Returns: AuthorityId

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AccountId.eq

Overrides U8a.eq

Defined in type/AccountId.ts:46

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

Defined in type/AccountId.ts:53

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

Defined in type/AccountId.ts:60

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

Defined in type/AccountId.ts:27

Parameters:

Name Type
value Uint8Array

Returns: string

- - - diff --git a/docs/types/classes/_type_authorityid_.authorityid.md b/docs/types/classes/_type_authorityid_.authorityid.md deleted file mode 100644 index 94c8a84732..0000000000 --- a/docs/types/classes/_type_authorityid_.authorityid.md +++ /dev/null @@ -1,873 +0,0 @@ - - -# Hierarchy - -↳ [AccountId](_type_accountid_.accountid.md) - -**↳ AuthorityId** - -↳ [SessionKey](_type_sessionkey_.sessionkey.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new AuthorityId**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [AuthorityId](_type_authorityid_.authorityid.md) - -*Inherited from [AccountId](_type_accountid_.accountid.md).[constructor](_type_accountid_.accountid.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_.md#anyu8a) | new Uint8Array() | - -**Returns:** [AuthorityId](_type_authorityid_.authorityid.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[eq](_type_accountid_.accountid.md#eq)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[toJSON](_type_accountid_.accountid.md#tojson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[toString](_type_accountid_.accountid.md#tostring)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## `` encode - -▸ **encode**(value: *`Uint8Array`*): `string` - -*Inherited from [AccountId](_type_accountid_.accountid.md).[encode](_type_accountid_.accountid.md#encode)* - -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `Uint8Array` | - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_type_balance_.balance.html b/docs/types/classes/_type_balance_.balance.html deleted file mode 100644 index 560333cd11..0000000000 --- a/docs/types/classes/_type_balance_.balance.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Balance

description: The Substrate Balance representation as a U128.

Hierarchy

↳ U128

↳ Balance

↳ BalanceOf

↳ Amount

↳ AssetOf

Implements

Constructors

constructor

⊕ new Balance(value?: AnyNumber): Balance

Inherited from U128.constructor

Overrides UInt.constructor

Defined in primitive/U128.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: Balance

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_balance_.balance.md b/docs/types/classes/_type_balance_.balance.md deleted file mode 100644 index cbc5cb6c46..0000000000 --- a/docs/types/classes/_type_balance_.balance.md +++ /dev/null @@ -1,2034 +0,0 @@ - - -*__name__*: Balance - -*__description__*: The Substrate Balance representation as a [U128](_primitive_u128_.u128.md). - -# Hierarchy - -↳ [U128](_primitive_u128_.u128.md) - -**↳ Balance** - -↳ [BalanceOf](_type_balance_.balanceof.md) - -↳ [Amount](_type_amount_.amount.md) - -↳ [AssetOf](_type_assetof_.assetof.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Balance**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [Balance](_type_balance_.balance.md) - -*Inherited from [U128](_primitive_u128_.u128.md).[constructor](_primitive_u128_.u128.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Balance](_type_balance_.balance.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_balance_.balanceof.html b/docs/types/classes/_type_balance_.balanceof.html deleted file mode 100644 index 014c3da768..0000000000 --- a/docs/types/classes/_type_balance_.balanceof.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BalanceOf

description: The Substrate BalanceOf representation as a Balance.

Hierarchy

↳ Balance

↳ BalanceOf

Implements

Constructors

constructor

⊕ new BalanceOf(value?: AnyNumber): BalanceOf

Inherited from U128.constructor

Overrides UInt.constructor

Defined in primitive/U128.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: BalanceOf

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_balance_.balanceof.md b/docs/types/classes/_type_balance_.balanceof.md deleted file mode 100644 index 0c133bab66..0000000000 --- a/docs/types/classes/_type_balance_.balanceof.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: BalanceOf - -*__description__*: The Substrate BalanceOf representation as a [Balance](_type_balance_.balance.md). - -# Hierarchy - -↳ [Balance](_type_balance_.balance.md) - -**↳ BalanceOf** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new BalanceOf**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [BalanceOf](_type_balance_.balanceof.md) - -*Inherited from [U128](_primitive_u128_.u128.md).[constructor](_primitive_u128_.u128.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U128.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U128.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [BalanceOf](_type_balance_.balanceof.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_bft_.bftauthoritysignature.html b/docs/types/classes/_type_bft_.bftauthoritysignature.html deleted file mode 100644 index 6e771daa3b..0000000000 --- a/docs/types/classes/_type_bft_.bftauthoritysignature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BftAuthoritySignature

description: Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour.

Hierarchy

↳ Tuple

↳ BftAuthoritySignature

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new BftAuthoritySignature(value?: BftAuthoritySignatureValue | Uint8Array): BftAuthoritySignature

Overrides Tuple.constructor

Defined in type/Bft.ts:20

Parameters:

Name Type
Optional value BftAuthoritySignatureValue | Uint8Array

Returns: BftAuthoritySignature

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

authorityId

get authorityId(): AuthorityId

Defined in type/Bft.ts:31

description: The wrapped [[AuthoriyId]]

Returns: AuthorityId

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

signature

get signature(): Signature

Defined in type/Bft.ts:38

description: The wrapped Signature value

Returns: Signature

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_bft_.bftauthoritysignature.md b/docs/types/classes/_type_bft_.bftauthoritysignature.md deleted file mode 100644 index 0a1e0351bb..0000000000 --- a/docs/types/classes/_type_bft_.bftauthoritysignature.md +++ /dev/null @@ -1,1198 +0,0 @@ - - -*__name__*: BftAuthoritySignature - -*__description__*: Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour. - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ BftAuthoritySignature** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new BftAuthoritySignature**(value?: *[BftAuthoritySignatureValue](../modules/_type_bft_.md#bftauthoritysignaturevalue) \| `Uint8Array`*): [BftAuthoritySignature](_type_bft_.bftauthoritysignature.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [type/Bft.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L20)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [BftAuthoritySignatureValue](../modules/_type_bft_.md#bftauthoritysignaturevalue) \| `Uint8Array` | - -**Returns:** [BftAuthoritySignature](_type_bft_.bftauthoritysignature.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## authorityId - -**get authorityId**(): [AuthorityId](_type_authorityid_.authorityid.md) - -*Defined in [type/Bft.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L31)* - -*__description__*: The wrapped \[\[AuthoriyId\]\] - -**Returns:** [AuthorityId](_type_authorityid_.authorityid.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## signature - -**get signature**(): [Signature](_type_signature_.signature.md) - -*Defined in [type/Bft.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L38)* - -*__description__*: The wrapped [Signature](_type_signature_.signature.md) value - -**Returns:** [Signature](_type_signature_.signature.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_bft_.bfthashsignature.html b/docs/types/classes/_type_bft_.bfthashsignature.html deleted file mode 100644 index 60f5189c1e..0000000000 --- a/docs/types/classes/_type_bft_.bfthashsignature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BftHashSignature

description: Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour.

Hierarchy

↳ Tuple

↳ BftHashSignature

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new BftHashSignature(value?: BftHashSignatureValue | Uint8Array): BftHashSignature

Overrides Tuple.constructor

Defined in type/Bft.ts:51

Parameters:

Name Type
Optional value BftHashSignatureValue | Uint8Array

Returns: BftHashSignature

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

hash

get hash(): Hash

Defined in type/Bft.ts:62

description: The wrapped Hash

Returns: Hash

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

signature

get signature(): Signature

Defined in type/Bft.ts:69

description: The wrapped Signature

Returns: Signature

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_bft_.bfthashsignature.md b/docs/types/classes/_type_bft_.bfthashsignature.md deleted file mode 100644 index 4fe293cd76..0000000000 --- a/docs/types/classes/_type_bft_.bfthashsignature.md +++ /dev/null @@ -1,1198 +0,0 @@ - - -*__name__*: BftHashSignature - -*__description__*: Represents a Bft Hash and Signature pairing, typically used in reporting network behaviour. - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ BftHashSignature** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new BftHashSignature**(value?: *[BftHashSignatureValue](../modules/_type_bft_.md#bfthashsignaturevalue) \| `Uint8Array`*): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [type/Bft.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L51)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [BftHashSignatureValue](../modules/_type_bft_.md#bfthashsignaturevalue) \| `Uint8Array` | - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## hash - -**get hash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Bft.ts:62](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L62)* - -*__description__*: The wrapped [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## signature - -**get signature**(): [Signature](_type_signature_.signature.md) - -*Defined in [type/Bft.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L69)* - -*__description__*: The wrapped [Signature](_type_signature_.signature.md) - -**Returns:** [Signature](_type_signature_.signature.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_block_.block.html b/docs/types/classes/_type_block_.block.html deleted file mode 100644 index 8146a5d471..0000000000 --- a/docs/types/classes/_type_block_.block.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Block

description: A block encoded with header and extrinsics

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Block

Implements

Constructors

constructor

⊕ new Block(value?: BlockValue | Uint8Array): Block

Overrides Struct.constructor

Defined in type/Block.ts:24

Parameters:

Name Type
Optional value BlockValue | Uint8Array

Returns: Block

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

contentHash

get contentHash(): Hash

Defined in type/Block.ts:35

description: Encodes a content Hash for the block

Returns: Hash

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

extrinsics

get extrinsics(): Extrinsics

Defined in type/Block.ts:44

description: The Extrinsics contained in the block

Returns: Extrinsics

hash

get hash(): Hash

Defined in type/Block.ts:51

description: Block/header Hash

Returns: Hash

get header(): Header

Defined in type/Block.ts:58

description: The Header of the block

Returns: Header

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_block_.block.md b/docs/types/classes/_type_block_.block.md deleted file mode 100644 index 58d0bf0e03..0000000000 --- a/docs/types/classes/_type_block_.block.md +++ /dev/null @@ -1,500 +0,0 @@ - - -*__name__*: Block - -*__description__*: A block encoded with header and extrinsics - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Block** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Block**(value?: *[BlockValue](../modules/_type_block_.md#blockvalue) \| `Uint8Array`*): [Block](_type_block_.block.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/Block.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L24)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [BlockValue](../modules/_type_block_.md#blockvalue) \| `Uint8Array` | - -**Returns:** [Block](_type_block_.block.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## contentHash - -**get contentHash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Block.ts:35](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L35)* - -*__description__*: Encodes a content [Hash](_type_hash_.hash.md) for the block - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## extrinsics - -**get extrinsics**(): [Extrinsics](_type_extrinsics_.extrinsics.md) - -*Defined in [type/Block.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L44)* - -*__description__*: The [Extrinsics](_type_extrinsics_.extrinsics.md) contained in the block - -**Returns:** [Extrinsics](_type_extrinsics_.extrinsics.md) - -___ - - -## hash - -**get hash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Block.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L51)* - -*__description__*: Block/header [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## header - -**get header**(): [Header](_type_header_.header.md) - -*Defined in [type/Block.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L58)* - -*__description__*: The [Header](_type_header_.header.md) of the block - -**Returns:** [Header](_type_header_.header.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_blocknumber_.blocknumber.html b/docs/types/classes/_type_blocknumber_.blocknumber.html deleted file mode 100644 index 5da3769590..0000000000 --- a/docs/types/classes/_type_blocknumber_.blocknumber.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BlockNumber

description: A representation of a Substrate BlockNumber, implemented as a U64

Hierarchy

↳ U64

↳ BlockNumber

Implements

Constructors

constructor

⊕ new BlockNumber(value?: AnyNumber): BlockNumber

Inherited from U64.constructor

Overrides UInt.constructor

Defined in primitive/U64.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: BlockNumber

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_blocknumber_.blocknumber.md b/docs/types/classes/_type_blocknumber_.blocknumber.md deleted file mode 100644 index 5f498a685d..0000000000 --- a/docs/types/classes/_type_blocknumber_.blocknumber.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: BlockNumber - -*__description__*: A representation of a Substrate BlockNumber, implemented as a [U64](_primitive_u64_.u64.md) - -# Hierarchy - -↳ [U64](_primitive_u64_.u64.md) - -**↳ BlockNumber** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new BlockNumber**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Inherited from [U64](_primitive_u64_.u64.md).[constructor](_primitive_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_codehash_.codehash.html b/docs/types/classes/_type_codehash_.codehash.html deleted file mode 100644 index 8942bdcb75..0000000000 --- a/docs/types/classes/_type_codehash_.codehash.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: CodeHash

description: The default contract code hash that is used accross the system. It is a wrapper around Hash, representing a 32-byte blake2b (Substrate) value

Hierarchy

↳ Hash

↳ CodeHash

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new CodeHash(value?: AnyU8a): CodeHash

Inherited from H256.constructor

Overrides U8aFixed.constructor

Defined in primitive/H256.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: CodeHash

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_codehash_.codehash.md b/docs/types/classes/_type_codehash_.codehash.md deleted file mode 100644 index 9c2d7f0e51..0000000000 --- a/docs/types/classes/_type_codehash_.codehash.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: CodeHash - -*__description__*: The default contract code hash that is used accross the system. It is a wrapper around [Hash](_type_hash_.hash.md), representing a 32-byte blake2b (Substrate) value - -# Hierarchy - -↳ [Hash](_type_hash_.hash.md) - -**↳ CodeHash** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new CodeHash**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [CodeHash](_type_codehash_.codehash.md) - -*Inherited from [H256](_primitive_h256_.h256.md).[constructor](_primitive_h256_.h256.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [CodeHash](_type_codehash_.codehash.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_digest_.authoritieschange.html b/docs/types/classes/_type_digest_.authoritieschange.html deleted file mode 100644 index 92fa9555ba..0000000000 --- a/docs/types/classes/_type_digest_.authoritieschange.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: AuthoritiesChange

description: Log for Authories changed

Type parameters

T : Codec

Hierarchy

↳ Vector

↳ AuthoritiesChange

Implements

Indexable

[n: number]: T

Constructors

constructor

⊕ new AuthoritiesChange(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): AuthoritiesChange

Inherited from Vector.constructor

Defined in codec/Vector.ts:22

Parameters:

Name Type Default value
Type Constructor<T> -
Default value value Vector<any> | Uint8Array | string | Array<any> [] as Array<any>

Returns: AuthoritiesChange

Accessors

Type

get Type(): string

Inherited from Vector.Type

Defined in codec/Vector.ts:66

description: The type for the items

Returns: string

encodedLength

get encodedLength(): number

Inherited from Vector.encodedLength

Defined in codec/Vector.ts:73

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Vector.isEmpty

Defined in codec/Vector.ts:59

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Inherited from Vector.length

Overrides Array.length

Defined in codec/Vector.ts:82

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<T>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<T>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<T>[]): T[]

▸ concat(...items: (T | ConcatArray<T>)[]): T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<T>[] Additional items to add to the end of array1.

Returns: T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: T[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, T]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, T]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

Defined in codec/Vector.ts:90

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: T, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value T value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

Defined in codec/Vector.ts:173

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<T>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): T | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : T

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: T | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: T, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement T The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(_other?: any): number

Inherited from Vector.indexOf

Overrides Array.indexOf

Defined in codec/Vector.ts:97

description: Finds the index of the value in the array

Parameters:

Name Type
Optional _other any

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: T, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement T The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

Defined in codec/Vector.ts:182

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): T | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: T | undefined

push

▸ push(...items: T[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items T[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): T

▸ reduce(callbackfn: function, initialValue: T): T

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): T

▸ reduceRight(callbackfn: function, initialValue: T): T

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): T[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: T[]

shift

▸ shift(): T | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: T | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): T[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: T[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): T[]

▸ splice(start: number, deleteCount: number, ...items: T[]): T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items T[] Elements to insert into the array in place of the deleted elements.

Returns: T[]

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

Defined in codec/Vector.ts:115

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

Defined in codec/Vector.ts:122

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

Defined in codec/Vector.ts:129

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

Defined in codec/Vector.ts:138

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Vector.toU8a

Defined in codec/Vector.ts:151

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: T[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items T[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<T>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<T>

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

Name Type
Type Constructor<T>
value Vector<any> | Uint8Array | string | Array<any>

Returns: Array<T>

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

Name Type
Type Constructor<O>

Returns: Constructor<Vector<O>>

- - - diff --git a/docs/types/classes/_type_digest_.authoritieschange.md b/docs/types/classes/_type_digest_.authoritieschange.md deleted file mode 100644 index 895d20bae7..0000000000 --- a/docs/types/classes/_type_digest_.authoritieschange.md +++ /dev/null @@ -1,1203 +0,0 @@ - - -*__name__*: AuthoritiesChange - -*__description__*: Log for Authories changed - -# Type parameters -#### T : [Codec](../interfaces/_types_.codec.md) -# Hierarchy - -↳ [Vector](_codec_vector_.vector.md) - -**↳ AuthoritiesChange** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: `T` -# Constructors - - - -## constructor - -⊕ **new AuthoritiesChange**(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): [AuthoritiesChange](_type_digest_.authoritieschange.md) - -*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* - -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | [] as Array<any> | - -**Returns:** [AuthoritiesChange](_type_digest_.authoritieschange.md) - -___ - -# Accessors - - - -## Type - -**get Type**(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66)* - -*__description__*: The type for the items - -**Returns:** `string` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* - -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* - -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* - -*Overrides Array.length* - -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`T`> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<`T`> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<`T`>[]*): `T`[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<`T`>[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `T`]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `T`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`T`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `T` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<`T`> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `T` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : `T` -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `T` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(_other?: *`any`*): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[indexOf](_codec_vector_.vector.md#indexof)* - -*Overrides Array.indexOf* - -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97)* - -*__description__*: Finds the index of the value in the array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` _other | `any` | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): `T` \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## push - -▸ **push**(...items: *`T`[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `T` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `T` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `T`[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** `T`[] - -___ - - -## shift - -▸ **shift**(): `T` \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `T`[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `T`[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): `T`[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *`T`[]*): `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | `T`[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** `T`[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* - -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`T`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* - -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* - -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* - -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *`T`[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`T`> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<`T`> - -___ - - -## `` decodeVector - -▸ **decodeVector**<`T`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### T : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | - -**Returns:** `Array`<`T`> - -___ - - -## `` with - -▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`O`>*): [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48)* - -**Type parameters:** - -#### O : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`O`> | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -___ - diff --git a/docs/types/classes/_type_digest_.changestrieroot.html b/docs/types/classes/_type_digest_.changestrieroot.html deleted file mode 100644 index 8824bd16ef..0000000000 --- a/docs/types/classes/_type_digest_.changestrieroot.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ChangesTrieRoot

description: Log for changes to the Trie root

Hierarchy

↳ Hash

↳ ChangesTrieRoot

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new ChangesTrieRoot(value?: AnyU8a): ChangesTrieRoot

Inherited from H256.constructor

Overrides U8aFixed.constructor

Defined in primitive/H256.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: ChangesTrieRoot

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_digest_.changestrieroot.md b/docs/types/classes/_type_digest_.changestrieroot.md deleted file mode 100644 index 4811402ac7..0000000000 --- a/docs/types/classes/_type_digest_.changestrieroot.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: ChangesTrieRoot - -*__description__*: Log for changes to the Trie root - -# Hierarchy - -↳ [Hash](_type_hash_.hash.md) - -**↳ ChangesTrieRoot** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new ChangesTrieRoot**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [ChangesTrieRoot](_type_digest_.changestrieroot.md) - -*Inherited from [H256](_primitive_h256_.h256.md).[constructor](_primitive_h256_.h256.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [ChangesTrieRoot](_type_digest_.changestrieroot.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_digest_.digest.html b/docs/types/classes/_type_digest_.digest.html deleted file mode 100644 index e9972714fd..0000000000 --- a/docs/types/classes/_type_digest_.digest.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Digest

description: A Header Digest

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Digest

Implements

Constructors

constructor

⊕ new Digest(value: any): Digest

Overrides Struct.constructor

Defined in type/Digest.ts:117

Parameters:

Name Type
value any

Returns: Digest

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

logs

get logs(): Vector<DigestItem>

Defined in type/Digest.ts:127

description: The DigestItem logs

Returns: Vector<DigestItem>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_digest_.digest.md b/docs/types/classes/_type_digest_.digest.md deleted file mode 100644 index 02fd4e8fc8..0000000000 --- a/docs/types/classes/_type_digest_.digest.md +++ /dev/null @@ -1,461 +0,0 @@ - - -*__name__*: Digest - -*__description__*: A [Header](_type_header_.header.md) Digest - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Digest** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Digest**(value: *`any`*): [Digest](_type_digest_.digest.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/Digest.ts:117](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L117)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** [Digest](_type_digest_.digest.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## logs - -**get logs**(): [Vector](_codec_vector_.vector.md)<[DigestItem](_type_digest_.digestitem.md)> - -*Defined in [type/Digest.ts:127](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L127)* - -*__description__*: The [DigestItem](_type_digest_.digestitem.md) logs - -**Returns:** [Vector](_codec_vector_.vector.md)<[DigestItem](_type_digest_.digestitem.md)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_digest_.digestitem.html b/docs/types/classes/_type_digest_.digestitem.html deleted file mode 100644 index a95df64adc..0000000000 --- a/docs/types/classes/_type_digest_.digestitem.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: DigestItem

description: A EnumType the specifies the specific item in the logs of a Digest

Hierarchy

↳ EnumType<AuthoritiesChange | ChangesTrieRoot | Other | Seal>

↳ DigestItem

Implements

Constructors

constructor

⊕ new DigestItem(value: any): DigestItem

Overrides EnumType.constructor

Defined in type/Digest.ts:73

Parameters:

Name Type
value any

Returns: DigestItem

Accessors

asAuthoritiesChange

get asAuthoritiesChange(): AuthoritiesChange

Defined in type/Digest.ts:86

description: Returns the item as a AuthoritiesChange

Returns: AuthoritiesChange

asChangesTrieRoot

get asChangesTrieRoot(): ChangesTrieRoot

Defined in type/Digest.ts:93

description: Returns the item as a ChangesTrieRoot

Returns: ChangesTrieRoot

asOther

get asOther(): Other

Defined in type/Digest.ts:100

description: Returns the item as a Other

Returns: Other

asSeal

get asSeal(): Seal

Defined in type/Digest.ts:107

description: Returns the item as a Seal

Returns: Seal

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_type_digest_.digestitem.md b/docs/types/classes/_type_digest_.digestitem.md deleted file mode 100644 index c1d4b6f396..0000000000 --- a/docs/types/classes/_type_digest_.digestitem.md +++ /dev/null @@ -1,335 +0,0 @@ - - -*__name__*: DigestItem - -*__description__*: A [EnumType](_codec_enumtype_.enumtype.md) the specifies the specific item in the logs of a [Digest](_type_digest_.digest.md) - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<[AuthoritiesChange](_type_digest_.authoritieschange.md) \| [ChangesTrieRoot](_type_digest_.changestrieroot.md) \| [Other](_type_digest_.other.md) \| [Seal](_type_digest_.seal.md)> - -**↳ DigestItem** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new DigestItem**(value: *`any`*): [DigestItem](_type_digest_.digestitem.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [type/Digest.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L73)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** [DigestItem](_type_digest_.digestitem.md) - -___ - -# Accessors - - - -## asAuthoritiesChange - -**get asAuthoritiesChange**(): [AuthoritiesChange](_type_digest_.authoritieschange.md) - -*Defined in [type/Digest.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L86)* - -*__description__*: Returns the item as a [AuthoritiesChange](_type_digest_.authoritieschange.md) - -**Returns:** [AuthoritiesChange](_type_digest_.authoritieschange.md) - -___ - - -## asChangesTrieRoot - -**get asChangesTrieRoot**(): [ChangesTrieRoot](_type_digest_.changestrieroot.md) - -*Defined in [type/Digest.ts:93](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L93)* - -*__description__*: Returns the item as a [ChangesTrieRoot](_type_digest_.changestrieroot.md) - -**Returns:** [ChangesTrieRoot](_type_digest_.changestrieroot.md) - -___ - - -## asOther - -**get asOther**(): [Other](_type_digest_.other.md) - -*Defined in [type/Digest.ts:100](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L100)* - -*__description__*: Returns the item as a [Other](_type_digest_.other.md) - -**Returns:** [Other](_type_digest_.other.md) - -___ - - -## asSeal - -**get asSeal**(): [Seal](_type_digest_.seal.md) - -*Defined in [type/Digest.ts:107](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L107)* - -*__description__*: Returns the item as a [Seal](_type_digest_.seal.md) - -**Returns:** [Seal](_type_digest_.seal.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_digest_.other.html b/docs/types/classes/_type_digest_.other.html deleted file mode 100644 index 157083aceb..0000000000 --- a/docs/types/classes/_type_digest_.other.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Other

description: Log item that is just a stream of Bytes

Hierarchy

↳ Bytes

↳ Other

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Other(value?: AnyU8a): Other

Inherited from Bytes.constructor

Overrides U8a.constructor

Defined in primitive/Bytes.ts:18

Parameters:

Name Type
Optional value AnyU8a

Returns: Other

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

Defined in primitive/Bytes.ts:61

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

Defined in primitive/Bytes.ts:69

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_digest_.other.md b/docs/types/classes/_type_digest_.other.md deleted file mode 100644 index 99b4a5efac..0000000000 --- a/docs/types/classes/_type_digest_.other.md +++ /dev/null @@ -1,841 +0,0 @@ - - -*__name__*: Other - -*__description__*: Log item that is just a stream of [Bytes](_primitive_bytes_.bytes.md) - -# Hierarchy - -↳ [Bytes](_primitive_bytes_.bytes.md) - -**↳ Other** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Other**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Other](_type_digest_.other.md) - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[constructor](_primitive_bytes_.bytes.md#constructor)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Other](_type_digest_.other.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[encodedLength](_primitive_bytes_.bytes.md#encodedlength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[toU8a](_primitive_bytes_.bytes.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_digest_.seal.html b/docs/types/classes/_type_digest_.seal.html deleted file mode 100644 index dbfbdbe26d..0000000000 --- a/docs/types/classes/_type_digest_.seal.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Seal

description: Log item indicating a sealing event

Hierarchy

↳ Tuple

↳ Seal

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new Seal(value: any): Seal

Overrides Tuple.constructor

Defined in type/Digest.ts:44

Parameters:

Name Type
value any

Returns: Seal

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

signature

get signature(): Signature

Defined in type/Digest.ts:55

description: The wrapped Signature

Returns: Signature

slot

get slot(): U64

Defined in type/Digest.ts:62

description: The wrapped U64 slot

Returns: U64

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_digest_.seal.md b/docs/types/classes/_type_digest_.seal.md deleted file mode 100644 index dfdaa67e59..0000000000 --- a/docs/types/classes/_type_digest_.seal.md +++ /dev/null @@ -1,1198 +0,0 @@ - - -*__name__*: Seal - -*__description__*: Log item indicating a sealing event - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ Seal** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new Seal**(value: *`any`*): [Seal](_type_digest_.seal.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [type/Digest.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L44)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** [Seal](_type_digest_.seal.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## signature - -**get signature**(): [Signature](_type_signature_.signature.md) - -*Defined in [type/Digest.ts:55](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L55)* - -*__description__*: The wrapped [Signature](_type_signature_.signature.md) - -**Returns:** [Signature](_type_signature_.signature.md) - -___ - - -## slot - -**get slot**(): [U64](_primitive_u64_.u64.md) - -*Defined in [type/Digest.ts:62](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Digest.ts#L62)* - -*__description__*: The wrapped [U64](_primitive_u64_.u64.md) slot - -**Returns:** [U64](_primitive_u64_.u64.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_event_.event.html b/docs/types/classes/_type_event_.event.html deleted file mode 100644 index 4ac45424ea..0000000000 --- a/docs/types/classes/_type_event_.event.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Event

description: A representation of a system event. These are generated via the Metadata interfaces and specific to a specific Substrate runtime

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Event

Implements

Constructors

constructor

⊕ new Event(_value?: Uint8Array): Event

Overrides Struct.constructor

Defined in type/Event.ts:86

Parameters:

Name Type
Optional _value Uint8Array

Returns: Event

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

data

get data(): EventData

Defined in type/Event.ts:144

description: The wrapped EventData

Returns: EventData

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): EventIndex

Defined in type/Event.ts:151

description: The EventIndex, identifying the raw event

Returns: EventIndex

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

meta

get meta(): EventMetadata

Defined in type/Event.ts:158

description: The EventMetadata with the documentation

Returns: EventMetadata

method

get method(): string

Defined in type/Event.ts:165

description: The method string identifying the event

Returns: string

section

get section(): string

Defined in type/Event.ts:172

description: The section string identifying the event

Returns: string

typeDef

get typeDef(): Array<TypeDef>

Defined in type/Event.ts:179

description: The TypeDef for the event

Returns: Array<TypeDef>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> decodeEvent

▸ decodeEvent(value?: Uint8Array): object | object

Defined in type/Event.ts:98

Parameters:

Name Type Default value
Default value value Uint8Array new Uint8Array()

Returns: object | object

<Static> injectMetadata

▸ injectMetadata(metadata: MetadataV0): void

Defined in type/Event.ts:122

Parameters:

Name Type
metadata MetadataV0

Returns: void

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_event_.event.md b/docs/types/classes/_type_event_.event.md deleted file mode 100644 index 9c7073f26d..0000000000 --- a/docs/types/classes/_type_event_.event.md +++ /dev/null @@ -1,560 +0,0 @@ - - -*__name__*: Event - -*__description__*: A representation of a system event. These are generated via the [Metadata](_metadata_metadata_.metadata.md) interfaces and specific to a specific Substrate runtime - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Event** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Event**(_value?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Event](_type_event_.event.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/Event.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L86)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` _value | [Uint8Array](_codec_u8a_.u8a.md#uint8array) | - -**Returns:** [Event](_type_event_.event.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## data - -**get data**(): [EventData](_type_event_.eventdata.md) - -*Defined in [type/Event.ts:144](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L144)* - -*__description__*: The wrapped [EventData](_type_event_.eventdata.md) - -**Returns:** [EventData](_type_event_.eventdata.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): [EventIndex](_type_event_.eventindex.md) - -*Defined in [type/Event.ts:151](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L151)* - -*__description__*: The [EventIndex](_type_event_.eventindex.md), identifying the raw event - -**Returns:** [EventIndex](_type_event_.eventindex.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## meta - -**get meta**(): [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -*Defined in [type/Event.ts:158](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L158)* - -*__description__*: The [EventMetadata](_metadata_v0_events_.eventmetadata.md) with the documentation - -**Returns:** [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -___ - - -## method - -**get method**(): `string` - -*Defined in [type/Event.ts:165](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L165)* - -*__description__*: The method string identifying the event - -**Returns:** `string` - -___ - - -## section - -**get section**(): `string` - -*Defined in [type/Event.ts:172](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L172)* - -*__description__*: The section string identifying the event - -**Returns:** `string` - -___ - - -## typeDef - -**get typeDef**(): `Array`<[TypeDef](../modules/_types_.md#typedef)> - -*Defined in [type/Event.ts:179](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L179)* - -*__description__*: The [TypeDef](../modules/_types_.md#typedef) for the event - -**Returns:** `Array`<[TypeDef](../modules/_types_.md#typedef)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` decodeEvent - -▸ **decodeEvent**(value?: *`Uint8Array`*): `object` \| `object` - -*Defined in [type/Event.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L98)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | `Uint8Array` | new Uint8Array() | - -**Returns:** `object` \| `object` - -___ - - -## `` injectMetadata - -▸ **injectMetadata**(metadata: *[MetadataV0](_metadata_v0_metadata_.metadatav0.md)*): `void` - -*Defined in [type/Event.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L122)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| metadata | [MetadataV0](_metadata_v0_metadata_.metadatav0.md) | - -**Returns:** `void` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_event_.eventdata.html b/docs/types/classes/_type_event_.eventdata.html deleted file mode 100644 index 5e4e86938c..0000000000 --- a/docs/types/classes/_type_event_.eventdata.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: EventData

description: Wrapper for the actual data that forms part of an Event

Hierarchy

↳ Tuple

↳ EventData

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new EventData(Types: Array<Constructor>, value: Uint8Array, typeDef: Array<TypeDef>, meta: EventMetadata, section: string, method: string): EventData

Overrides Tuple.constructor

Defined in type/Event.ts:28

Parameters:

Name Type
Types Array<Constructor>
value Uint8Array
typeDef Array<TypeDef>
meta EventMetadata
section string
method string

Returns: EventData

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

meta

get meta(): EventMetadata

Defined in type/Event.ts:42

description: The wrapped EventMetadata

Returns: EventMetadata

method

get method(): string

Defined in type/Event.ts:49

description: The method as a string

Returns: string

section

get section(): string

Defined in type/Event.ts:56

description: The section as a string

Returns: string

typeDef

get typeDef(): Array<TypeDef>

Defined in type/Event.ts:63

description: The TypeDef for this event

Returns: Array<TypeDef>

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_event_.eventdata.md b/docs/types/classes/_type_event_.eventdata.md deleted file mode 100644 index 9a721abeb5..0000000000 --- a/docs/types/classes/_type_event_.eventdata.md +++ /dev/null @@ -1,1229 +0,0 @@ - - -*__name__*: EventData - -*__description__*: Wrapper for the actual data that forms part of an [Event](_type_event_.event.md) - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ EventData** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new EventData**(Types: *`Array`<[Constructor](../interfaces/_types_.constructor.md)>*, value: *`Uint8Array`*, typeDef: *`Array`<[TypeDef](../modules/_types_.md#typedef)>*, meta: *[EventMetadata](_metadata_v0_events_.eventmetadata.md)*, section: *`string`*, method: *`string`*): [EventData](_type_event_.eventdata.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [type/Event.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L28)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `Array`<[Constructor](../interfaces/_types_.constructor.md)> | -| value | `Uint8Array` | -| typeDef | `Array`<[TypeDef](../modules/_types_.md#typedef)> | -| meta | [EventMetadata](_metadata_v0_events_.eventmetadata.md) | -| section | `string` | -| method | `string` | - -**Returns:** [EventData](_type_event_.eventdata.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## meta - -**get meta**(): [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -*Defined in [type/Event.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L42)* - -*__description__*: The wrapped [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -**Returns:** [EventMetadata](_metadata_v0_events_.eventmetadata.md) - -___ - - -## method - -**get method**(): `string` - -*Defined in [type/Event.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L49)* - -*__description__*: The method as a string - -**Returns:** `string` - -___ - - -## section - -**get section**(): `string` - -*Defined in [type/Event.ts:56](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L56)* - -*__description__*: The section as a string - -**Returns:** `string` - -___ - - -## typeDef - -**get typeDef**(): `Array`<[TypeDef](../modules/_types_.md#typedef)> - -*Defined in [type/Event.ts:63](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L63)* - -*__description__*: The [TypeDef](../modules/_types_.md#typedef) for this event - -**Returns:** `Array`<[TypeDef](../modules/_types_.md#typedef)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_event_.eventindex.html b/docs/types/classes/_type_event_.eventindex.html deleted file mode 100644 index bd7c7ce2d8..0000000000 --- a/docs/types/classes/_type_event_.eventindex.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: EventIndex

description: This follows the same approach as in Method, we have the [sectionIndex, methodIndex] pairing that indicates the actual event fired

Hierarchy

↳ U8aFixed

↳ EventIndex

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new EventIndex(value?: any): EventIndex

Overrides U8aFixed.constructor

Defined in type/Event.ts:74

Parameters:

Name Type
Optional value any

Returns: EventIndex

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_event_.eventindex.md b/docs/types/classes/_type_event_.eventindex.md deleted file mode 100644 index 83610dc407..0000000000 --- a/docs/types/classes/_type_event_.eventindex.md +++ /dev/null @@ -1,850 +0,0 @@ - - -*__name__*: EventIndex - -*__description__*: This follows the same approach as in [Method](_primitive_method_.method.md), we have the `[sectionIndex, methodIndex]` pairing that indicates the actual event fired - -# Hierarchy - -↳ [U8aFixed](_codec_u8afixed_.u8afixed.md) - -**↳ EventIndex** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new EventIndex**(value?: *`any`*): [EventIndex](_type_event_.eventindex.md) - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [type/Event.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Event.ts#L74)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [EventIndex](_type_event_.eventindex.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_eventrecord_.applyextrinsic.html b/docs/types/classes/_type_eventrecord_.applyextrinsic.html deleted file mode 100644 index 28e35d0566..0000000000 --- a/docs/types/classes/_type_eventrecord_.applyextrinsic.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ApplyExtrinsic

description: The Phase where the extrinsic is applied

Hierarchy

↳ U32

↳ ApplyExtrinsic

Implements

Constructors

constructor

⊕ new ApplyExtrinsic(value?: AnyNumber): ApplyExtrinsic

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: ApplyExtrinsic

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_eventrecord_.applyextrinsic.md b/docs/types/classes/_type_eventrecord_.applyextrinsic.md deleted file mode 100644 index 567fa43af0..0000000000 --- a/docs/types/classes/_type_eventrecord_.applyextrinsic.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: ApplyExtrinsic - -*__description__*: The [Phase](_type_eventrecord_.phase.md) where the extrinsic is applied - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ ApplyExtrinsic** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ApplyExtrinsic**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_eventrecord_.eventrecord.html b/docs/types/classes/_type_eventrecord_.eventrecord.html deleted file mode 100644 index 21cecd6e59..0000000000 --- a/docs/types/classes/_type_eventrecord_.eventrecord.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: EventRecord

description: A record for an Event (as specified by Metadata) with the specific Phase of application.

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ EventRecord

Implements

Constructors

constructor

⊕ new EventRecord(value: any): EventRecord

Overrides Struct.constructor

Defined in type/EventRecord.ts:61

Parameters:

Name Type
value any

Returns: EventRecord

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

event

get event(): Event

Defined in type/EventRecord.ts:72

description: The Event this record refers to

Returns: Event

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

phase

get phase(): Phase

Defined in type/EventRecord.ts:79

description: The Phase where the event was generated

Returns: Phase

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_eventrecord_.eventrecord.md b/docs/types/classes/_type_eventrecord_.eventrecord.md deleted file mode 100644 index 65d8961102..0000000000 --- a/docs/types/classes/_type_eventrecord_.eventrecord.md +++ /dev/null @@ -1,474 +0,0 @@ - - -*__name__*: EventRecord - -*__description__*: A record for an [Event](_type_event_.event.md) (as specified by [Metadata](_metadata_metadata_.metadata.md)) with the specific [Phase](_type_eventrecord_.phase.md) of application. - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ EventRecord** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new EventRecord**(value: *`any`*): [EventRecord](_type_eventrecord_.eventrecord.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/EventRecord.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L61)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | - -**Returns:** [EventRecord](_type_eventrecord_.eventrecord.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## event - -**get event**(): [Event](_type_event_.event.md) - -*Defined in [type/EventRecord.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L72)* - -*__description__*: The [Event](_type_event_.event.md) this record refers to - -**Returns:** [Event](_type_event_.event.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## phase - -**get phase**(): [Phase](_type_eventrecord_.phase.md) - -*Defined in [type/EventRecord.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L79)* - -*__description__*: The [Phase](_type_eventrecord_.phase.md) where the event was generated - -**Returns:** [Phase](_type_eventrecord_.phase.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_eventrecord_.finalization.html b/docs/types/classes/_type_eventrecord_.finalization.html deleted file mode 100644 index 87a6ff69cd..0000000000 --- a/docs/types/classes/_type_eventrecord_.finalization.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Finalization

description: The Phase where the extrinsic is being Finalized

Hierarchy

Null

↳ Finalization

Implements

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_type_eventrecord_.finalization.md b/docs/types/classes/_type_eventrecord_.finalization.md deleted file mode 100644 index d292ea2282..0000000000 --- a/docs/types/classes/_type_eventrecord_.finalization.md +++ /dev/null @@ -1,149 +0,0 @@ - - -*__name__*: Finalization - -*__description__*: The [Phase](_type_eventrecord_.phase.md) where the extrinsic is being Finalized - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Finalization** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_type_eventrecord_.phase.html b/docs/types/classes/_type_eventrecord_.phase.html deleted file mode 100644 index 82a7e22d72..0000000000 --- a/docs/types/classes/_type_eventrecord_.phase.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Phase

description: An EnumType that indicates the specific phase where the EventRecord was generated

Hierarchy

↳ EnumType<ApplyExtrinsic | Finalization>

↳ Phase

Implements

Constructors

constructor

⊕ new Phase(value: any, index?: undefined | number): Phase

Overrides EnumType.constructor

Defined in type/EventRecord.ts:32

Parameters:

Name Type
value any
Optional index undefined | number

Returns: Phase

Accessors

asApplyExtrinsic

get asApplyExtrinsic(): ApplyExtrinsic

Defined in type/EventRecord.ts:43

description: Returns the item as a ApplyExtrinsic

Returns: ApplyExtrinsic

asFinalization

get asFinalization(): Finalization

Defined in type/EventRecord.ts:50

description: Returns the item as a Finalization

Returns: Finalization

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_type_eventrecord_.phase.md b/docs/types/classes/_type_eventrecord_.phase.md deleted file mode 100644 index e6eecb5b8a..0000000000 --- a/docs/types/classes/_type_eventrecord_.phase.md +++ /dev/null @@ -1,310 +0,0 @@ - - -*__name__*: Phase - -*__description__*: An [EnumType](_codec_enumtype_.enumtype.md) that indicates the specific phase where the [EventRecord](_type_eventrecord_.eventrecord.md) was generated - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<[ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) \| [Finalization](_type_eventrecord_.finalization.md)> - -**↳ Phase** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Phase**(value: *`any`*, index?: *`undefined` \| `number`*): [Phase](_type_eventrecord_.phase.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [type/EventRecord.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L32)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | -| `Optional` index | `undefined` \| `number` | - -**Returns:** [Phase](_type_eventrecord_.phase.md) - -___ - -# Accessors - - - -## asApplyExtrinsic - -**get asApplyExtrinsic**(): [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) - -*Defined in [type/EventRecord.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L43)* - -*__description__*: Returns the item as a [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) - -**Returns:** [ApplyExtrinsic](_type_eventrecord_.applyextrinsic.md) - -___ - - -## asFinalization - -**get asFinalization**(): [Finalization](_type_eventrecord_.finalization.md) - -*Defined in [type/EventRecord.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/EventRecord.ts#L50)* - -*__description__*: Returns the item as a [Finalization](_type_eventrecord_.finalization.md) - -**Returns:** [Finalization](_type_eventrecord_.finalization.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_extrinsic_.extrinsic.html b/docs/types/classes/_type_extrinsic_.extrinsic.html deleted file mode 100644 index 984b18e654..0000000000 --- a/docs/types/classes/_type_extrinsic_.extrinsic.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Extrinsic

description: Representation of an Extrinsic in the system. It contains the actual call, (optional) signature and encodes with an actual length prefix

https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node.

Can be:

  • signed, to create a transaction
  • left as is, to create an inherent

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Extrinsic

Implements

Constructors

constructor

⊕ new Extrinsic(value?: ExtrinsicValue | AnyU8a | Method): Extrinsic

Overrides Struct.constructor

Defined in type/Extrinsic.ts:36

Parameters:

Name Type
Optional value ExtrinsicValue | AnyU8a | Method

Returns: Extrinsic

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

args

get args(): Array<Codec>

Defined in type/Extrinsic.ts:76

description: The arguments passed to for the call, exposes args so it is compatible with Method

Returns: Array<Codec>

callIndex

get callIndex(): Uint8Array

Defined in type/Extrinsic.ts:83

description: The actual [sectionIndex, methodIndex] as used in the Method

Returns: Uint8Array

data

get data(): Uint8Array

Defined in type/Extrinsic.ts:90

description: The actual data for the Method

Returns: Uint8Array

encodedLength

get encodedLength(): number

Overrides Struct.encodedLength

Defined in type/Extrinsic.ts:97

description: The length of the value when encoded as a Uint8Array

Returns: number

hash

get hash(): Hash

Defined in type/Extrinsic.ts:106

description: Convernience function, encodes the extrinsic and returns the actual hash

Returns: Hash

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

isSigned

get isSigned(): boolean

Defined in type/Extrinsic.ts:115

description: true id the extrinsic is signed

Returns: boolean

length

get length(): number

Defined in type/Extrinsic.ts:122

description: The length of the encoded value

Returns: number

meta

get meta(): FunctionMetadata

Defined in type/Extrinsic.ts:129

description: The FunctionMetadata that describes the extrinsic

Returns: FunctionMetadata

method

get method(): Method

Defined in type/Extrinsic.ts:136

description: The Method this extrinsic wraps

Returns: Method

signature

get signature(): ExtrinsicSignature

Defined in type/Extrinsic.ts:143

description: The ExtrinsicSignature

Returns: ExtrinsicSignature

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

addSignature

▸ addSignature(signer: Address | Uint8Array, signature: Uint8Array, nonce: AnyNumber, era?: Uint8Array): Extrinsic

Defined in type/Extrinsic.ts:150

description: Add an ExtrinsicSignature to the extrinsic (already generated)

Parameters:

Name Type
signer Address | Uint8Array
signature Uint8Array
nonce AnyNumber
Optional era Uint8Array

Returns: Extrinsic

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

sign

▸ sign(account: KeyringPair, options: SignatureOptions): Extrinsic

Defined in type/Extrinsic.ts:159

description: Sign the extrinsic with a specific keypair

Parameters:

Name Type
account KeyringPair
options SignatureOptions

Returns: Extrinsic

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Overrides Struct.toHex

Defined in type/Extrinsic.ts:168

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Struct.toJSON

Defined in type/Extrinsic.ts:175

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Overrides Struct.toU8a

Defined in type/Extrinsic.ts:183

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> decodeExtrinsic

▸ decodeExtrinsic(value: ExtrinsicValue | AnyU8a | Method): ExtrinsicValue | Array<number> | Uint8Array

Defined in type/Extrinsic.ts:44

Parameters:

Name Type
value ExtrinsicValue | AnyU8a | Method

Returns: ExtrinsicValue | Array<number> | Uint8Array

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_extrinsic_.extrinsic.md b/docs/types/classes/_type_extrinsic_.extrinsic.md deleted file mode 100644 index 84db05139e..0000000000 --- a/docs/types/classes/_type_extrinsic_.extrinsic.md +++ /dev/null @@ -1,631 +0,0 @@ - - -*__name__*: Extrinsic - -*__description__*: Representation of an Extrinsic in the system. It contains the actual call, (optional) signature and encodes with an actual length prefix - -[https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node](https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node). - -Can be: - -* signed, to create a transaction -* left as is, to create an inherent - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Extrinsic** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Extrinsic**(value?: *`ExtrinsicValue` \| [AnyU8a](../modules/_types_.md#anyu8a) \| [Method](_primitive_method_.method.md)*): [Extrinsic](_type_extrinsic_.extrinsic.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/Extrinsic.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L36)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `ExtrinsicValue` \| [AnyU8a](../modules/_types_.md#anyu8a) \| [Method](_primitive_method_.method.md) | - -**Returns:** [Extrinsic](_type_extrinsic_.extrinsic.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## args - -**get args**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Defined in [type/Extrinsic.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L76)* - -*__description__*: The arguments passed to for the call, exposes args so it is compatible with [Method](_primitive_method_.method.md) - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## callIndex - -**get callIndex**(): `Uint8Array` - -*Defined in [type/Extrinsic.ts:83](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L83)* - -*__description__*: The actual `[sectionIndex, methodIndex]` as used in the Method - -**Returns:** `Uint8Array` - -___ - - -## data - -**get data**(): `Uint8Array` - -*Defined in [type/Extrinsic.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L90)* - -*__description__*: The actual data for the Method - -**Returns:** `Uint8Array` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [type/Extrinsic.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L97)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## hash - -**get hash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Extrinsic.ts:106](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L106)* - -*__description__*: Convernience function, encodes the extrinsic and returns the actual hash - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isSigned - -**get isSigned**(): `boolean` - -*Defined in [type/Extrinsic.ts:115](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L115)* - -*__description__*: `true` id the extrinsic is signed - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Defined in [type/Extrinsic.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L122)* - -*__description__*: The length of the encoded value - -**Returns:** `number` - -___ - - -## meta - -**get meta**(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -*Defined in [type/Extrinsic.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L129)* - -*__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) that describes the extrinsic - -**Returns:** [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -___ - - -## method - -**get method**(): [Method](_primitive_method_.method.md) - -*Defined in [type/Extrinsic.ts:136](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L136)* - -*__description__*: The [Method](_primitive_method_.method.md) this extrinsic wraps - -**Returns:** [Method](_primitive_method_.method.md) - -___ - - -## signature - -**get signature**(): [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -*Defined in [type/Extrinsic.ts:143](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L143)* - -*__description__*: The [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -**Returns:** [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## addSignature - -▸ **addSignature**(signer: *[Address](_type_address_.address.md) \| `Uint8Array`*, signature: *`Uint8Array`*, nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, era?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [Extrinsic](_type_extrinsic_.extrinsic.md) - -*Defined in [type/Extrinsic.ts:150](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L150)* - -*__description__*: Add an [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) to the extrinsic (already generated) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signer | [Address](_type_address_.address.md) \| `Uint8Array` | -| signature | `Uint8Array` | -| nonce | [AnyNumber](../modules/_types_.md#anynumber) | -| `Optional` era | [Uint8Array](_codec_u8a_.u8a.md#uint8array) | - -**Returns:** [Extrinsic](_type_extrinsic_.extrinsic.md) - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## sign - -▸ **sign**(account: *`KeyringPair`*, options: *[SignatureOptions](../modules/_types_.md#signatureoptions)*): [Extrinsic](_type_extrinsic_.extrinsic.md) - -*Defined in [type/Extrinsic.ts:159](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L159)* - -*__description__*: Sign the extrinsic with a specific keypair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| account | `KeyringPair` | -| options | [SignatureOptions](../modules/_types_.md#signatureoptions) | - -**Returns:** [Extrinsic](_type_extrinsic_.extrinsic.md) - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Overrides [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [type/Extrinsic.ts:168](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L168)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [type/Extrinsic.ts:175](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L175)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [type/Extrinsic.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L183)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` decodeExtrinsic - -▸ **decodeExtrinsic**(value: *`ExtrinsicValue` \| [AnyU8a](../modules/_types_.md#anyu8a) \| [Method](_primitive_method_.method.md)*): `ExtrinsicValue` \| `Array`<`number`> \| `Uint8Array` - -*Defined in [type/Extrinsic.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Extrinsic.ts#L44)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `ExtrinsicValue` \| [AnyU8a](../modules/_types_.md#anyu8a) \| [Method](_primitive_method_.method.md) | - -**Returns:** `ExtrinsicValue` \| `Array`<`number`> \| `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_extrinsicera_.extrinsicera.html b/docs/types/classes/_type_extrinsicera_.extrinsicera.html deleted file mode 100644 index da51cda3aa..0000000000 --- a/docs/types/classes/_type_extrinsicera_.extrinsicera.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ExtrinsicEra

description: The era for an extrinsic, indicating either a mortal or immortal extrinsic

Hierarchy

↳ U8a

↳ ExtrinsicEra

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new ExtrinsicEra(value?: AnyU8a): ExtrinsicEra

Overrides U8a.constructor

Defined in type/ExtrinsicEra.ts:16

Parameters:

Name Type
Optional value AnyU8a

Returns: ExtrinsicEra

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

<Static> decodeExtrinsicEra

▸ decodeExtrinsicEra(value?: AnyU8a): Uint8Array

Defined in type/ExtrinsicEra.ts:23

Parameters:

Name Type
Optional value AnyU8a

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_type_extrinsicera_.extrinsicera.md b/docs/types/classes/_type_extrinsicera_.extrinsicera.md deleted file mode 100644 index ec2ad019c1..0000000000 --- a/docs/types/classes/_type_extrinsicera_.extrinsicera.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: ExtrinsicEra - -*__description__*: The era for an extrinsic, indicating either a mortal or immortal extrinsic - -# Hierarchy - -↳ [U8a](_codec_u8a_.u8a.md) - -**↳ ExtrinsicEra** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new ExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [type/ExtrinsicEra.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicEra.ts#L16)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## `` decodeExtrinsicEra - -▸ **decodeExtrinsicEra**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): `Uint8Array` - -*Defined in [type/ExtrinsicEra.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicEra.ts#L23)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_type_extrinsics_.extrinsics.html b/docs/types/classes/_type_extrinsics_.extrinsics.html deleted file mode 100644 index 96c0979d54..0000000000 --- a/docs/types/classes/_type_extrinsics_.extrinsics.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Extrinsics

description: A Vector of Extrinsic

Type parameters

T : Codec

Hierarchy

↳ Vector

↳ Extrinsics

↳ PendingExtrinsics

Implements

Indexable

[n: number]: T

Constructors

constructor

⊕ new Extrinsics(Type: Constructor<T>, value?: Vector<any> | Uint8Array | string | Array<any>): Extrinsics

Inherited from Vector.constructor

Defined in codec/Vector.ts:22

Parameters:

Name Type Default value
Type Constructor<T> -
Default value value Vector<any> | Uint8Array | string | Array<any> [] as Array<any>

Returns: Extrinsics

Accessors

Type

get Type(): string

Inherited from Vector.Type

Defined in codec/Vector.ts:66

description: The type for the items

Returns: string

encodedLength

get encodedLength(): number

Inherited from Vector.encodedLength

Defined in codec/Vector.ts:73

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Vector.isEmpty

Defined in codec/Vector.ts:59

description: Checks if the value is an empty value

Returns: boolean

length

get length(): number

Inherited from Vector.length

Overrides Array.length

Defined in codec/Vector.ts:82

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<T>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<T>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<T>[]): T[]

▸ concat(...items: (T | ConcatArray<T>)[]): T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<T>[] Additional items to add to the end of array1.

Returns: T[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: T[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, T]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, T]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Vector.eq

Defined in codec/Vector.ts:90

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: T, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value T value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<T>

Inherited from Vector.filter

Overrides Array.filter

Defined in codec/Vector.ts:173

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<T>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): T | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : T

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: T | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: T, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement T The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(_other?: any): number

Inherited from Vector.indexOf

Overrides Array.indexOf

Defined in codec/Vector.ts:97

description: Finds the index of the value in the array

Parameters:

Name Type
Optional _other any

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: T, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement T The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Vector.map

Overrides Array.map

Defined in codec/Vector.ts:182

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): T | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: T | undefined

push

▸ push(...items: T[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items T[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): T

▸ reduce(callbackfn: function, initialValue: T): T

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): T

▸ reduceRight(callbackfn: function, initialValue: T): T

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue T

Returns: T

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): T[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: T[]

shift

▸ shift(): T | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: T | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): T[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: T[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): T[]

▸ splice(start: number, deleteCount: number, ...items: T[]): T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: T[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items T[] Elements to insert into the array in place of the deleted elements.

Returns: T[]

toArray

▸ toArray(): Array<T>

Inherited from Vector.toArray

Defined in codec/Vector.ts:115

description: Converts the Object to an standard JavaScript Array

Returns: Array<T>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Vector.toHex

Defined in codec/Vector.ts:122

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Vector.toJSON

Defined in codec/Vector.ts:129

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Vector.toString

Overrides Array.toString

Defined in codec/Vector.ts:138

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Vector.toU8a

Defined in codec/Vector.ts:151

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: T[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items T[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<T>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<T>

<Static> decodeVector

▸ decodeVector<T>(Type: Constructor<T>, value: Vector<any> | Uint8Array | string | Array<any>): Array<T>

Inherited from Vector.decodeVector

Defined in codec/Vector.ts:32

Type parameters:

T : Codec

Parameters:

Name Type
Type Constructor<T>
value Vector<any> | Uint8Array | string | Array<any>

Returns: Array<T>

<Static> with

▸ with<O>(Type: Constructor<O>): Constructor<Vector<O>>

Inherited from Vector.with

Defined in codec/Vector.ts:48

Type parameters:

O : Codec

Parameters:

Name Type
Type Constructor<O>

Returns: Constructor<Vector<O>>

- - - diff --git a/docs/types/classes/_type_extrinsics_.extrinsics.md b/docs/types/classes/_type_extrinsics_.extrinsics.md deleted file mode 100644 index 5f632dd9b2..0000000000 --- a/docs/types/classes/_type_extrinsics_.extrinsics.md +++ /dev/null @@ -1,1205 +0,0 @@ - - -*__name__*: Extrinsics - -*__description__*: A [Vector](_codec_vector_.vector.md) of [Extrinsic](_type_extrinsic_.extrinsic.md) - -# Type parameters -#### T : [Codec](../interfaces/_types_.codec.md) -# Hierarchy - -↳ [Vector](_codec_vector_.vector.md) - -**↳ Extrinsics** - -↳ [PendingExtrinsics](_rpc_pendingextrinsics_.pendingextrinsics.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: `T` -# Constructors - - - -## constructor - -⊕ **new Extrinsics**(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value?: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): [Extrinsics](_type_extrinsics_.extrinsics.md) - -*Inherited from [Vector](_codec_vector_.vector.md).[constructor](_codec_vector_.vector.md#constructor)* - -*Defined in [codec/Vector.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L22)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | - | -| `Default value` value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | [] as Array<any> | - -**Returns:** [Extrinsics](_type_extrinsics_.extrinsics.md) - -___ - -# Accessors - - - -## Type - -**get Type**(): `string` - -*Inherited from [Vector](_codec_vector_.vector.md).[Type](_codec_vector_.vector.md#type)* - -*Defined in [codec/Vector.ts:66](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L66)* - -*__description__*: The type for the items - -**Returns:** `string` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[encodedLength](_codec_vector_.vector.md#encodedlength)* - -*Defined in [codec/Vector.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L73)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Vector](_codec_vector_.vector.md).[isEmpty](_codec_vector_.vector.md#isempty)* - -*Defined in [codec/Vector.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L59)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[length](_codec_vector_.vector.md#length)* - -*Overrides Array.length* - -*Defined in [codec/Vector.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L82)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`T`> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<`T`> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<`T`>[]*): `T`[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<`T`>[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** `T`[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `T`]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `T`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Vector](_codec_vector_.vector.md).[eq](_codec_vector_.vector.md#eq)* - -*Defined in [codec/Vector.ts:90](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L90)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`T`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `T` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[filter](_codec_vector_.vector.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Vector.ts:173](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L173)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<`T`> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `T` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : `T` -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `T` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(_other?: *`any`*): `number` - -*Inherited from [Vector](_codec_vector_.vector.md).[indexOf](_codec_vector_.vector.md#indexof)* - -*Overrides Array.indexOf* - -*Defined in [codec/Vector.ts:97](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L97)* - -*__description__*: Finds the index of the value in the array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` _other | `any` | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`T`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `T` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Vector](_codec_vector_.vector.md).[map](_codec_vector_.vector.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Vector.ts:182](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L182)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): `T` \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## push - -▸ **push**(...items: *`T`[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `T` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `T` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`T`*): `T` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `T` | - -**Returns:** `T` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `T`[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** `T`[] - -___ - - -## shift - -▸ **shift**(): `T` \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** `T` \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `T`[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `T`[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): `T`[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *`T`[]*): `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** `T`[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | `T`[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** `T`[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[toArray](_codec_vector_.vector.md#toarray)* - -*Defined in [codec/Vector.ts:115](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L115)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<`T`> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toHex](_codec_vector_.vector.md#tohex)* - -*Defined in [codec/Vector.ts:122](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L122)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toJSON](_codec_vector_.vector.md#tojson)* - -*Defined in [codec/Vector.ts:129](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L129)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toString](_codec_vector_.vector.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Vector.ts:138](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L138)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Vector](_codec_vector_.vector.md).[toU8a](_codec_vector_.vector.md#tou8a)* - -*Defined in [codec/Vector.ts:151](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L151)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *`T`[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `T`[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`T`> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<`T`> - -___ - - -## `` decodeVector - -▸ **decodeVector**<`T`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`T`>*, value: *[Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`>*): `Array`<`T`> - -*Inherited from [Vector](_codec_vector_.vector.md).[decodeVector](_codec_vector_.vector.md#decodevector)* - -*Defined in [codec/Vector.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L32)* - -**Type parameters:** - -#### T : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`T`> | -| value | [Vector](_codec_vector_.vector.md)<`any`> \| `Uint8Array` \| `string` \| `Array`<`any`> | - -**Returns:** `Array`<`T`> - -___ - - -## `` with - -▸ **with**<`O`>(Type: *[Constructor](../interfaces/_types_.constructor.md)<`O`>*): [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -*Inherited from [Vector](_codec_vector_.vector.md).[with](_codec_vector_.vector.md#with)* - -*Defined in [codec/Vector.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Vector.ts#L48)* - -**Type parameters:** - -#### O : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<`O`> | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Vector](_codec_vector_.vector.md)<`O`>> - -___ - diff --git a/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.html b/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.html deleted file mode 100644 index a4295909e4..0000000000 --- a/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ExtrinsicSignature

description: A container for the Signature associated with a specific Extrinsic

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ ExtrinsicSignature

Implements

Constructors

constructor

⊕ new ExtrinsicSignature(value?: Uint8Array): ExtrinsicSignature

Overrides Struct.constructor

Defined in type/ExtrinsicSignature.ts:29

Parameters:

Name Type
Optional value Uint8Array

Returns: ExtrinsicSignature

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Overrides Struct.encodedLength

Defined in type/ExtrinsicSignature.ts:66

description: The length of the value when encoded as a Uint8Array

Returns: number

era

get era(): ExtrinsicEra

Defined in type/ExtrinsicSignature.ts:82

description: The ExtrinsicEra (mortal or immortal) this signature applies to

Returns: ExtrinsicEra

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

isSigned

get isSigned(): boolean

Defined in type/ExtrinsicSignature.ts:75

description: true if the signature is valid

Returns: boolean

nonce

get nonce(): Nonce

Defined in type/ExtrinsicSignature.ts:89

description: The Nonce for the signature

Returns: Nonce

signature

get signature(): Signature

Defined in type/ExtrinsicSignature.ts:96

description: The actuall Signature hash

Returns: Signature

signer

get signer(): Address

Defined in type/ExtrinsicSignature.ts:103

description: The Address that signed

Returns: Address

version

get version(): number

Defined in type/ExtrinsicSignature.ts:110

description: The encoded version for the signature

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

addSignature

▸ addSignature(_signer: Address | Uint8Array, _signature: Uint8Array, _nonce: AnyNumber, _era?: Uint8Array): ExtrinsicSignature

Defined in type/ExtrinsicSignature.ts:131

description: Adds a raw signature

Parameters:

Name Type Default value
_signer Address | Uint8Array -
_signature Uint8Array -
_nonce AnyNumber -
Default value _era Uint8Array IMMORTAL_ERA

Returns: ExtrinsicSignature

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

sign

▸ sign(method: Method, account: KeyringPair, __namedParameters: object): ExtrinsicSignature

Defined in type/ExtrinsicSignature.ts:143

description: Generate a payload and pplies the signature from a keypair

Parameters:

Name Type
method Method
account KeyringPair
__namedParameters object

Returns: ExtrinsicSignature

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Overrides Struct.toU8a

Defined in type/ExtrinsicSignature.ts:160

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> decodeExtrinsicSignature

▸ decodeExtrinsicSignature(value?: Uint8Array): object | Uint8Array

Defined in type/ExtrinsicSignature.ts:46

Parameters:

Name Type
Optional value Uint8Array

Returns: object | Uint8Array

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md b/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md deleted file mode 100644 index 25b28f9c11..0000000000 --- a/docs/types/classes/_type_extrinsicsignature_.extrinsicsignature.md +++ /dev/null @@ -1,586 +0,0 @@ - - -*__name__*: ExtrinsicSignature - -*__description__*: A container for the [Signature](_type_signature_.signature.md) associated with a specific [Extrinsic](_type_extrinsic_.extrinsic.md) - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ ExtrinsicSignature** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ExtrinsicSignature**(value?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/ExtrinsicSignature.ts:29](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L29)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [Uint8Array](_codec_u8a_.u8a.md#uint8array) | - -**Returns:** [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Overrides [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [type/ExtrinsicSignature.ts:66](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L66)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## era - -**get era**(): [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -*Defined in [type/ExtrinsicSignature.ts:82](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L82)* - -*__description__*: The [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) (mortal or immortal) this signature applies to - -**Returns:** [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isSigned - -**get isSigned**(): `boolean` - -*Defined in [type/ExtrinsicSignature.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L75)* - -*__description__*: `true` if the signature is valid - -**Returns:** `boolean` - -___ - - -## nonce - -**get nonce**(): [Nonce](_type_nonce_.nonce.md) - -*Defined in [type/ExtrinsicSignature.ts:89](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L89)* - -*__description__*: The [Nonce](_type_nonce_.nonce.md) for the signature - -**Returns:** [Nonce](_type_nonce_.nonce.md) - -___ - - -## signature - -**get signature**(): [Signature](_type_signature_.signature.md) - -*Defined in [type/ExtrinsicSignature.ts:96](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L96)* - -*__description__*: The actuall [Signature](_type_signature_.signature.md) hash - -**Returns:** [Signature](_type_signature_.signature.md) - -___ - - -## signer - -**get signer**(): [Address](_type_address_.address.md) - -*Defined in [type/ExtrinsicSignature.ts:103](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L103)* - -*__description__*: The [Address](_type_address_.address.md) that signed - -**Returns:** [Address](_type_address_.address.md) - -___ - - -## version - -**get version**(): `number` - -*Defined in [type/ExtrinsicSignature.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L110)* - -*__description__*: The encoded version for the signature - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## addSignature - -▸ **addSignature**(_signer: *[Address](_type_address_.address.md) \| `Uint8Array`*, _signature: *`Uint8Array`*, _nonce: *[AnyNumber](../modules/_types_.md#anynumber)*, _era?: *`Uint8Array`*): [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -*Defined in [type/ExtrinsicSignature.ts:131](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L131)* - -*__description__*: Adds a raw signature - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| _signer | [Address](_type_address_.address.md) \| `Uint8Array` | - | -| _signature | `Uint8Array` | - | -| _nonce | [AnyNumber](../modules/_types_.md#anynumber) | - | -| `Default value` _era | `Uint8Array` | IMMORTAL_ERA | - -**Returns:** [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## sign - -▸ **sign**(method: *[Method](_primitive_method_.method.md)*, account: *`KeyringPair`*, __namedParameters: *`object`*): [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -*Defined in [type/ExtrinsicSignature.ts:143](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L143)* - -*__description__*: Generate a payload and pplies the signature from a keypair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| method | [Method](_primitive_method_.method.md) | -| account | `KeyringPair` | -| __namedParameters | `object` | - -**Returns:** [ExtrinsicSignature](_type_extrinsicsignature_.extrinsicsignature.md) - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Overrides [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [type/ExtrinsicSignature.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L160)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` decodeExtrinsicSignature - -▸ **decodeExtrinsicSignature**(value?: *[Uint8Array](_codec_u8a_.u8a.md#uint8array)*): `object` \| `Uint8Array` - -*Defined in [type/ExtrinsicSignature.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L46)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [Uint8Array](_codec_u8a_.u8a.md#uint8array) | - -**Returns:** `object` \| `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_gas_.gas.html b/docs/types/classes/_type_gas_.gas.html deleted file mode 100644 index f1d2a6751f..0000000000 --- a/docs/types/classes/_type_gas_.gas.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Gas

description: A gas number type for Substrate, extending U64

Hierarchy

↳ U64

↳ Gas

Implements

Constructors

constructor

⊕ new Gas(value?: AnyNumber): Gas

Inherited from U64.constructor

Overrides UInt.constructor

Defined in primitive/U64.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: Gas

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_gas_.gas.md b/docs/types/classes/_type_gas_.gas.md deleted file mode 100644 index 8d4f2311ba..0000000000 --- a/docs/types/classes/_type_gas_.gas.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: Gas - -*__description__*: A gas number type for Substrate, extending [U64](_primitive_u64_.u64.md) - -# Hierarchy - -↳ [U64](_primitive_u64_.u64.md) - -**↳ Gas** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Gas**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [Gas](_type_gas_.gas.md) - -*Inherited from [U64](_primitive_u64_.u64.md).[constructor](_primitive_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Gas](_type_gas_.gas.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_hash_.hash.html b/docs/types/classes/_type_hash_.hash.html deleted file mode 100644 index 5b36a5fc99..0000000000 --- a/docs/types/classes/_type_hash_.hash.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Hash

description: The default hash that is used accross the system. It is basically just a thin wrapper around H256, representing a 32-byte blake2b (Substrate) value

Hierarchy

↳ H256

↳ Hash

↳ Finalised

↳ Usurped

↳ ChangesTrieRoot

↳ CodeHash

↳ SeedOf

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Hash(value?: AnyU8a): Hash

Inherited from H256.constructor

Overrides U8aFixed.constructor

Defined in primitive/H256.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: Hash

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_hash_.hash.md b/docs/types/classes/_type_hash_.hash.md deleted file mode 100644 index 9113126dd4..0000000000 --- a/docs/types/classes/_type_hash_.hash.md +++ /dev/null @@ -1,862 +0,0 @@ - - -*__name__*: Hash - -*__description__*: The default hash that is used accross the system. It is basically just a thin wrapper around [H256](_primitive_h256_.h256.md), representing a 32-byte blake2b (Substrate) value - -# Hierarchy - -↳ [H256](_primitive_h256_.h256.md) - -**↳ Hash** - -↳ [Finalised](_rpc_extrinsicstatus_.finalised.md) - -↳ [Usurped](_rpc_extrinsicstatus_.usurped.md) - -↳ [ChangesTrieRoot](_type_digest_.changestrieroot.md) - -↳ [CodeHash](_type_codehash_.codehash.md) - -↳ [SeedOf](_type_seedof_.seedof.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Hash**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Hash](_type_hash_.hash.md) - -*Inherited from [H256](_primitive_h256_.h256.md).[constructor](_primitive_h256_.h256.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_header_.header.html b/docs/types/classes/_type_header_.header.html deleted file mode 100644 index 642fa933a7..0000000000 --- a/docs/types/classes/_type_header_.header.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Header

description: A Block header

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Header

↳ HeaderExtended

Implements

Constructors

constructor

⊕ new Header(value?: HeaderValue | Uint8Array | null): Header

Overrides Struct.constructor

Defined in type/Header.ts:30

Parameters:

Name Type
Optional value HeaderValue | Uint8Array | null

Returns: Header

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

blockNumber

get blockNumber(): BlockNumber

Defined in type/Header.ts:44

description: The wrapped BlockNumber

Returns: BlockNumber

digest

get digest(): Digest

Defined in type/Header.ts:51

description: The wrapped Digest

Returns: Digest

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

extrinsicsRoot

get extrinsicsRoot(): Hash

Defined in type/Header.ts:58

description: The wrapped extrisics root as a Hash

Returns: Hash

hash

get hash(): Hash

Defined in type/Header.ts:65

description: Convenience method, encodes the header and calculates the Hash

Returns: Hash

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

parentHash

get parentHash(): Hash

Defined in type/Header.ts:74

description: The wrapped parent as a Hash

Returns: Hash

stateRoot

get stateRoot(): Hash

Defined in type/Header.ts:81

description: The wrapped state root as a Hash

Returns: Hash

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_header_.header.md b/docs/types/classes/_type_header_.header.md deleted file mode 100644 index 7f4fa2a5d1..0000000000 --- a/docs/types/classes/_type_header_.header.md +++ /dev/null @@ -1,528 +0,0 @@ - - -*__name__*: Header - -*__description__*: A [Block](_type_block_.block.md) header - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Header** - -↳ [HeaderExtended](_type_header_.headerextended.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Header**(value?: *[HeaderValue](../modules/_type_header_.md#headervalue) \| `Uint8Array` \| `null`*): [Header](_type_header_.header.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/Header.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L30)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [HeaderValue](../modules/_type_header_.md#headervalue) \| `Uint8Array` \| `null` | - -**Returns:** [Header](_type_header_.header.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## blockNumber - -**get blockNumber**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Defined in [type/Header.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L44)* - -*__description__*: The wrapped [BlockNumber](_type_blocknumber_.blocknumber.md) - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - - -## digest - -**get digest**(): [Digest](_type_digest_.digest.md) - -*Defined in [type/Header.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L51)* - -*__description__*: The wrapped [Digest](_type_digest_.digest.md) - -**Returns:** [Digest](_type_digest_.digest.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## extrinsicsRoot - -**get extrinsicsRoot**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Header.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L58)* - -*__description__*: The wrapped extrisics root as a [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## hash - -**get hash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Header.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L65)* - -*__description__*: Convenience method, encodes the header and calculates the [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## parentHash - -**get parentHash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Header.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L74)* - -*__description__*: The wrapped parent as a [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## stateRoot - -**get stateRoot**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Header.ts:81](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L81)* - -*__description__*: The wrapped state root as a [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_header_.headerextended.html b/docs/types/classes/_type_header_.headerextended.html deleted file mode 100644 index 0904eedf3c..0000000000 --- a/docs/types/classes/_type_header_.headerextended.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: HeaderExtended

description: A Block header with an additional author field that indicates the block author

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Header

↳ HeaderExtended

Implements

Constructors

constructor

⊕ new HeaderExtended(header?: Header | null, sessionValidators?: Array<AccountId>): HeaderExtended

Overrides Header.constructor

Defined in type/Header.ts:92

Parameters:

Name Type Default value
Default value header Header | null null
Default value sessionValidators Array<AccountId> []

Returns: HeaderExtended

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

author

get author(): AccountId | undefined

Defined in type/Header.ts:107

description: Convenience method, returns the author for the block

Returns: AccountId | undefined

blockNumber

get blockNumber(): BlockNumber

Inherited from Header.blockNumber

Defined in type/Header.ts:44

description: The wrapped BlockNumber

Returns: BlockNumber

digest

get digest(): Digest

Inherited from Header.digest

Defined in type/Header.ts:51

description: The wrapped Digest

Returns: Digest

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

extrinsicsRoot

get extrinsicsRoot(): Hash

Inherited from Header.extrinsicsRoot

Defined in type/Header.ts:58

description: The wrapped extrisics root as a Hash

Returns: Hash

hash

get hash(): Hash

Inherited from Header.hash

Defined in type/Header.ts:65

description: Convenience method, encodes the header and calculates the Hash

Returns: Hash

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

parentHash

get parentHash(): Hash

Inherited from Header.parentHash

Defined in type/Header.ts:74

description: The wrapped parent as a Hash

Returns: Hash

stateRoot

get stateRoot(): Hash

Inherited from Header.stateRoot

Defined in type/Header.ts:81

description: The wrapped state root as a Hash

Returns: Hash

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Overrides Struct.toJSON

Defined in type/Header.ts:114

description: Creates the JSON representation

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_header_.headerextended.md b/docs/types/classes/_type_header_.headerextended.md deleted file mode 100644 index 002affa945..0000000000 --- a/docs/types/classes/_type_header_.headerextended.md +++ /dev/null @@ -1,552 +0,0 @@ - - -*__name__*: HeaderExtended - -*__description__*: A [Block](_type_block_.block.md) header with an additional `author` field that indicates the block author - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Header](_type_header_.header.md) - -**↳ HeaderExtended** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new HeaderExtended**(header?: *[Header](_type_header_.header.md) \| `null`*, sessionValidators?: *`Array`<[AccountId](_type_accountid_.accountid.md)>*): [HeaderExtended](_type_header_.headerextended.md) - -*Overrides [Header](_type_header_.header.md).[constructor](_type_header_.header.md#constructor)* - -*Defined in [type/Header.ts:92](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L92)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` header | [Header](_type_header_.header.md) \| `null` | null | -| `Default value` sessionValidators | `Array`<[AccountId](_type_accountid_.accountid.md)> | [] | - -**Returns:** [HeaderExtended](_type_header_.headerextended.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## author - -**get author**(): [AccountId](_type_accountid_.accountid.md) \| `undefined` - -*Defined in [type/Header.ts:107](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L107)* - -*__description__*: Convenience method, returns the author for the block - -**Returns:** [AccountId](_type_accountid_.accountid.md) \| `undefined` - -___ - - -## blockNumber - -**get blockNumber**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Inherited from [Header](_type_header_.header.md).[blockNumber](_type_header_.header.md#blocknumber)* - -*Defined in [type/Header.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L44)* - -*__description__*: The wrapped [BlockNumber](_type_blocknumber_.blocknumber.md) - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - - -## digest - -**get digest**(): [Digest](_type_digest_.digest.md) - -*Inherited from [Header](_type_header_.header.md).[digest](_type_header_.header.md#digest)* - -*Defined in [type/Header.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L51)* - -*__description__*: The wrapped [Digest](_type_digest_.digest.md) - -**Returns:** [Digest](_type_digest_.digest.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## extrinsicsRoot - -**get extrinsicsRoot**(): [Hash](_type_hash_.hash.md) - -*Inherited from [Header](_type_header_.header.md).[extrinsicsRoot](_type_header_.header.md#extrinsicsroot)* - -*Defined in [type/Header.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L58)* - -*__description__*: The wrapped extrisics root as a [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## hash - -**get hash**(): [Hash](_type_hash_.hash.md) - -*Inherited from [Header](_type_header_.header.md).[hash](_type_header_.header.md#hash)* - -*Defined in [type/Header.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L65)* - -*__description__*: Convenience method, encodes the header and calculates the [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## parentHash - -**get parentHash**(): [Hash](_type_hash_.hash.md) - -*Inherited from [Header](_type_header_.header.md).[parentHash](_type_header_.header.md#parenthash)* - -*Defined in [type/Header.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L74)* - -*__description__*: The wrapped parent as a [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## stateRoot - -**get stateRoot**(): [Hash](_type_hash_.hash.md) - -*Inherited from [Header](_type_header_.header.md).[stateRoot](_type_header_.header.md#stateroot)* - -*Defined in [type/Header.ts:81](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L81)* - -*__description__*: The wrapped state root as a [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Overrides [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [type/Header.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L114)* - -*__description__*: Creates the JSON representation - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.html b/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.html deleted file mode 100644 index 30af3aef51..0000000000 --- a/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: InherentOfflineReport

description: Describes the offline-reporting extrinsic

Hierarchy

↳ Tuple

↳ InherentOfflineReport

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new InherentOfflineReport(Types: TupleConstructors, value: any): InherentOfflineReport

Inherited from Tuple.constructor

Defined in codec/Tuple.ts:22

Parameters:

Name Type
Types TupleConstructors
value any

Returns: InherentOfflineReport

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.md b/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.md deleted file mode 100644 index a3317ff20c..0000000000 --- a/docs/types/classes/_type_inherentofflinereport_.inherentofflinereport.md +++ /dev/null @@ -1,1173 +0,0 @@ - - -*__name__*: InherentOfflineReport - -*__description__*: Describes the offline-reporting extrinsic - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ InherentOfflineReport** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new InherentOfflineReport**(Types: *`TupleConstructors`*, value: *`any`*): [InherentOfflineReport](_type_inherentofflinereport_.inherentofflinereport.md) - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [codec/Tuple.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | -| value | `any` | - -**Returns:** [InherentOfflineReport](_type_inherentofflinereport_.inherentofflinereport.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_justification_.justification.html b/docs/types/classes/_type_justification_.justification.html deleted file mode 100644 index 9a8042bac1..0000000000 --- a/docs/types/classes/_type_justification_.justification.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Justification

description: A generic justification as a stream of Bytes, this is specific per consensus implementation

Hierarchy

↳ Bytes

↳ Justification

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Justification(value?: AnyU8a): Justification

Inherited from Bytes.constructor

Overrides U8a.constructor

Defined in primitive/Bytes.ts:18

Parameters:

Name Type
Optional value AnyU8a

Returns: Justification

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from Bytes.encodedLength

Overrides U8a.encodedLength

Defined in primitive/Bytes.ts:61

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Bytes.toU8a

Overrides U8a.toU8a

Defined in primitive/Bytes.ts:69

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_justification_.justification.md b/docs/types/classes/_type_justification_.justification.md deleted file mode 100644 index 009b2caa16..0000000000 --- a/docs/types/classes/_type_justification_.justification.md +++ /dev/null @@ -1,841 +0,0 @@ - - -*__name__*: Justification - -*__description__*: A generic justification as a stream of [Bytes](_primitive_bytes_.bytes.md), this is specific per consensus implementation - -# Hierarchy - -↳ [Bytes](_primitive_bytes_.bytes.md) - -**↳ Justification** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Justification**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Justification](_type_justification_.justification.md) - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[constructor](_primitive_bytes_.bytes.md#constructor)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[constructor](_codec_u8a_.u8a.md#constructor)* - -*Defined in [primitive/Bytes.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L18)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Justification](_type_justification_.justification.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[encodedLength](_primitive_bytes_.bytes.md#encodedlength)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [primitive/Bytes.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L61)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Bytes](_primitive_bytes_.bytes.md).[toU8a](_primitive_bytes_.bytes.md#tou8a)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [primitive/Bytes.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Bytes.ts#L69)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_justification_.rhdjustification.html b/docs/types/classes/_type_justification_.rhdjustification.html deleted file mode 100644 index 0cf4790b92..0000000000 --- a/docs/types/classes/_type_justification_.rhdjustification.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: RhdJustification

description: Justification for the Rhododendron consensus algorithm

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ RhdJustification

Implements

Constructors

constructor

⊕ new RhdJustification(value?: RhdJustificationValue | Uint8Array): RhdJustification

Overrides Struct.constructor

Defined in type/Justification.ts:33

Parameters:

Name Type
Optional value RhdJustificationValue | Uint8Array

Returns: RhdJustification

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

hash

get hash(): Hash

Defined in type/Justification.ts:47

description: The justification Hash

Returns: Hash

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

roundNumber

get roundNumber(): U32

Defined in type/Justification.ts:54

description: The round this justification wraps as a U32

Returns: U32

signatures

get signatures(): Vector<BftAuthoritySignature>

Defined in type/Justification.ts:61

description: The BftAuthoritySignature array

Returns: Vector<BftAuthoritySignature>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_justification_.rhdjustification.md b/docs/types/classes/_type_justification_.rhdjustification.md deleted file mode 100644 index 20388d05de..0000000000 --- a/docs/types/classes/_type_justification_.rhdjustification.md +++ /dev/null @@ -1,487 +0,0 @@ - - -*__name__*: RhdJustification - -*__description__*: [Justification](_type_justification_.justification.md) for the Rhododendron consensus algorithm - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ RhdJustification** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new RhdJustification**(value?: *[RhdJustificationValue](../modules/_type_justification_.md#rhdjustificationvalue) \| `Uint8Array`*): [RhdJustification](_type_justification_.rhdjustification.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/Justification.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L33)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [RhdJustificationValue](../modules/_type_justification_.md#rhdjustificationvalue) \| `Uint8Array` | - -**Returns:** [RhdJustification](_type_justification_.rhdjustification.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## hash - -**get hash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/Justification.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L47)* - -*__description__*: The justification [Hash](_type_hash_.hash.md) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## roundNumber - -**get roundNumber**(): [U32](_primitive_u32_.u32.md) - -*Defined in [type/Justification.ts:54](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L54)* - -*__description__*: The round this justification wraps as a [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - - -## signatures - -**get signatures**(): [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_type_bft_.bftauthoritysignature.md)> - -*Defined in [type/Justification.ts:61](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L61)* - -*__description__*: The [BftAuthoritySignature](_type_bft_.bftauthoritysignature.md) array - -**Returns:** [Vector](_codec_vector_.vector.md)<[BftAuthoritySignature](_type_bft_.bftauthoritysignature.md)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_keyvalue_.keyvalue.html b/docs/types/classes/_type_keyvalue_.keyvalue.html deleted file mode 100644 index ff8ba041ba..0000000000 --- a/docs/types/classes/_type_keyvalue_.keyvalue.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: KeyValue

description: KeyValue structure. Since most of the keys and resultant values in Subtrate is hashed and/or encoded, this does not wrap Text, but rather a Bytes for the keys and values. (Not to be confused with the KeyValue in Metadata, that is actually for Maps, whereas this is a representation of actaul storage values)

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ KeyValue

Implements

Constructors

constructor

⊕ new KeyValue(value?: KeyValueValue | Uint8Array): KeyValue

Overrides Struct.constructor

Defined in type/KeyValue.ts:26

Parameters:

Name Type
Optional value KeyValueValue | Uint8Array

Returns: KeyValue

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

key

get key(): StorageKey

Defined in type/KeyValue.ts:37

description: The StorageKey

Returns: StorageKey

value

get value(): StorageData

Defined in type/KeyValue.ts:44

description: The StorageData

Returns: StorageData

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_keyvalue_.keyvalue.md b/docs/types/classes/_type_keyvalue_.keyvalue.md deleted file mode 100644 index c307666cc3..0000000000 --- a/docs/types/classes/_type_keyvalue_.keyvalue.md +++ /dev/null @@ -1,474 +0,0 @@ - - -*__name__*: KeyValue - -*__description__*: KeyValue structure. Since most of the keys and resultant values in Subtrate is hashed and/or encoded, this does not wrap [Text](_primitive_text_.text.md), but rather a [Bytes](_primitive_bytes_.bytes.md) for the keys and values. (Not to be confused with the KeyValue in [Metadata](_metadata_metadata_.metadata.md), that is actually for Maps, whereas this is a representation of actaul storage values) - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ KeyValue** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new KeyValue**(value?: *`KeyValueValue` \| `Uint8Array`*): [KeyValue](_type_keyvalue_.keyvalue.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/KeyValue.ts:26](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L26)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `KeyValueValue` \| `Uint8Array` | - -**Returns:** [KeyValue](_type_keyvalue_.keyvalue.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## key - -**get key**(): [StorageKey](_primitive_storagekey_.storagekey.md) - -*Defined in [type/KeyValue.ts:37](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L37)* - -*__description__*: The [StorageKey](_primitive_storagekey_.storagekey.md) - -**Returns:** [StorageKey](_primitive_storagekey_.storagekey.md) - -___ - - -## value - -**get value**(): [StorageData](_primitive_storagedata_.storagedata.md) - -*Defined in [type/KeyValue.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L44)* - -*__description__*: The [StorageData](_primitive_storagedata_.storagedata.md) - -**Returns:** [StorageData](_primitive_storagedata_.storagedata.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_keyvalue_.keyvalueoption.html b/docs/types/classes/_type_keyvalue_.keyvalueoption.html deleted file mode 100644 index 5c71c03d77..0000000000 --- a/docs/types/classes/_type_keyvalue_.keyvalueoption.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: KeyValueOption

description: A key/value change. This is similar to the KeyValue structure, however in this case the value could be optional. Here it extends from a Tuple, indicating the use inside areas such as StorageChangeSet

Hierarchy

↳ Tuple

↳ KeyValueOption

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new KeyValueOption(value?: KeyValueOptionValue | Uint8Array): KeyValueOption

Overrides Tuple.constructor

Defined in type/KeyValue.ts:58

Parameters:

Name Type
Optional value KeyValueOptionValue | Uint8Array

Returns: KeyValueOption

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

key

get key(): StorageKey

Defined in type/KeyValue.ts:69

description: The StorageKey

Returns: StorageKey

value

get value(): Option<StorageData>

Defined in type/KeyValue.ts:76

description: The Option StorageData

Returns: Option<StorageData>

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_keyvalue_.keyvalueoption.md b/docs/types/classes/_type_keyvalue_.keyvalueoption.md deleted file mode 100644 index f01ebed1f1..0000000000 --- a/docs/types/classes/_type_keyvalue_.keyvalueoption.md +++ /dev/null @@ -1,1198 +0,0 @@ - - -*__name__*: KeyValueOption - -*__description__*: A key/value change. This is similar to the [KeyValue](_type_keyvalue_.keyvalue.md) structure, however in this case the value could be optional. Here it extends from a [Tuple](_codec_tuple_.tuple.md), indicating the use inside areas such as [StorageChangeSet](_rpc_storagechangeset_.storagechangeset.md) - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ KeyValueOption** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new KeyValueOption**(value?: *[KeyValueOptionValue](../modules/_type_keyvalue_.md#keyvalueoptionvalue) \| `Uint8Array`*): [KeyValueOption](_type_keyvalue_.keyvalueoption.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [type/KeyValue.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L58)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [KeyValueOptionValue](../modules/_type_keyvalue_.md#keyvalueoptionvalue) \| `Uint8Array` | - -**Returns:** [KeyValueOption](_type_keyvalue_.keyvalueoption.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## key - -**get key**(): [StorageKey](_primitive_storagekey_.storagekey.md) - -*Defined in [type/KeyValue.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L69)* - -*__description__*: The [StorageKey](_primitive_storagekey_.storagekey.md) - -**Returns:** [StorageKey](_primitive_storagekey_.storagekey.md) - -___ - - -## value - -**get value**(): [Option](_codec_option_.option.md)<[StorageData](_primitive_storagedata_.storagedata.md)> - -*Defined in [type/KeyValue.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L76)* - -*__description__*: The [Option](_codec_option_.option.md) [StorageData](_primitive_storagedata_.storagedata.md) - -**Returns:** [Option](_codec_option_.option.md)<[StorageData](_primitive_storagedata_.storagedata.md)> - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_lockperiods_.lockperiods.html b/docs/types/classes/_type_lockperiods_.lockperiods.html deleted file mode 100644 index c1e3dc96b7..0000000000 --- a/docs/types/classes/_type_lockperiods_.lockperiods.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: LocKPeriods

description: A number of lock periods.

Hierarchy

↳ I8

↳ LocKPeriods

Implements

Constructors

constructor

⊕ new LocKPeriods(value?: AnyNumber): LocKPeriods

Inherited from I8.constructor

Overrides Int.constructor

Defined in primitive/I8.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: LocKPeriods

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_lockperiods_.lockperiods.md b/docs/types/classes/_type_lockperiods_.lockperiods.md deleted file mode 100644 index 453560bdab..0000000000 --- a/docs/types/classes/_type_lockperiods_.lockperiods.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: LocKPeriods - -*__description__*: A number of lock periods. - -# Hierarchy - -↳ [I8](_primitive_i8_.i8.md) - -**↳ LocKPeriods** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new LocKPeriods**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [LocKPeriods](_type_lockperiods_.lockperiods.md) - -*Inherited from [I8](_primitive_i8_.i8.md).[constructor](_primitive_i8_.i8.md#constructor)* - -*Overrides [Int](_codec_int_.int.md).[constructor](_codec_int_.int.md#constructor)* - -*Defined in [primitive/I8.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/I8.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [LocKPeriods](_type_lockperiods_.lockperiods.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftatreport.html b/docs/types/classes/_type_misbehaviorreport_.bftatreport.html deleted file mode 100644 index 95c3773a80..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftatreport.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BftAtReport

description: A report of a/b hash-signature pairs for a specific index. This is the same structure as is used in BftDoublePrepare & BftDoubleCommit

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ BftAtReport

↳ BftDoublePropose

↳ BftDoublePrepare

↳ BftDoubleCommit

Implements

Constructors

constructor

⊕ new BftAtReport(value?: BftAtReportValue | Uint8Array): BftAtReport

Overrides Struct.constructor

Defined in type/MisbehaviorReport.ts:33

Parameters:

Name Type
Optional value BftAtReportValue | Uint8Array

Returns: BftAtReport

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

a

get a(): BftHashSignature

Defined in type/MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature

b

get b(): BftHashSignature

Defined in type/MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

round

get round(): U32

Defined in type/MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftatreport.md b/docs/types/classes/_type_misbehaviorreport_.bftatreport.md deleted file mode 100644 index 2fbf4838aa..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftatreport.md +++ /dev/null @@ -1,493 +0,0 @@ - - -*__name__*: BftAtReport - -*__description__*: A report of a/b hash-signature pairs for a specific index. This is the same structure as is used in BftDoublePrepare & BftDoubleCommit - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ BftAtReport** - -↳ [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) - -↳ [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) - -↳ [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new BftAtReport**(value?: *`BftAtReportValue` \| `Uint8Array`*): [BftAtReport](_type_misbehaviorreport_.bftatreport.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` \| `Uint8Array` | - -**Returns:** [BftAtReport](_type_misbehaviorreport_.bftatreport.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## a - -**get a**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45)* - -*__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## b - -**get b**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52)* - -*__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## round - -**get round**(): [U32](_primitive_u32_.u32.md) - -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59)* - -*__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.html b/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.html deleted file mode 100644 index 0fe093f8eb..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BftDoubleCommit

description: Report of a double-commit

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ BftAtReport

↳ BftDoubleCommit

Implements

Constructors

constructor

⊕ new BftDoubleCommit(value?: BftAtReportValue | Uint8Array): BftDoubleCommit

Inherited from BftAtReport.constructor

Overrides Struct.constructor

Defined in type/MisbehaviorReport.ts:33

Parameters:

Name Type
Optional value BftAtReportValue | Uint8Array

Returns: BftDoubleCommit

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

a

get a(): BftHashSignature

Inherited from BftAtReport.a

Defined in type/MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature

b

get b(): BftHashSignature

Inherited from BftAtReport.b

Defined in type/MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

round

get round(): U32

Inherited from BftAtReport.round

Defined in type/MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md b/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md deleted file mode 100644 index d1f5db96a0..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoublecommit.md +++ /dev/null @@ -1,495 +0,0 @@ - - -*__name__*: BftDoubleCommit - -*__description__*: Report of a double-commit - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [BftAtReport](_type_misbehaviorreport_.bftatreport.md) - -**↳ BftDoubleCommit** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new BftDoubleCommit**(value?: *`BftAtReportValue` \| `Uint8Array`*): [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[constructor](_type_misbehaviorreport_.bftatreport.md#constructor)* - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` \| `Uint8Array` | - -**Returns:** [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## a - -**get a**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[a](_type_misbehaviorreport_.bftatreport.md#a)* - -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45)* - -*__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## b - -**get b**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[b](_type_misbehaviorreport_.bftatreport.md#b)* - -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52)* - -*__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## round - -**get round**(): [U32](_primitive_u32_.u32.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[round](_type_misbehaviorreport_.bftatreport.md#round)* - -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59)* - -*__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html b/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html deleted file mode 100644 index 0cf7fe94db..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BftDoublePrepare

description: Report of a double-prepare

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ BftAtReport

↳ BftDoublePrepare

Implements

Constructors

constructor

⊕ new BftDoublePrepare(value?: BftAtReportValue | Uint8Array): BftDoublePrepare

Inherited from BftAtReport.constructor

Overrides Struct.constructor

Defined in type/MisbehaviorReport.ts:33

Parameters:

Name Type
Optional value BftAtReportValue | Uint8Array

Returns: BftDoublePrepare

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

a

get a(): BftHashSignature

Inherited from BftAtReport.a

Defined in type/MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature

b

get b(): BftHashSignature

Inherited from BftAtReport.b

Defined in type/MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

round

get round(): U32

Inherited from BftAtReport.round

Defined in type/MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md b/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md deleted file mode 100644 index 5f535cec54..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoubleprepare.md +++ /dev/null @@ -1,495 +0,0 @@ - - -*__name__*: BftDoublePrepare - -*__description__*: Report of a double-prepare - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [BftAtReport](_type_misbehaviorreport_.bftatreport.md) - -**↳ BftDoublePrepare** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new BftDoublePrepare**(value?: *`BftAtReportValue` \| `Uint8Array`*): [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[constructor](_type_misbehaviorreport_.bftatreport.md#constructor)* - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` \| `Uint8Array` | - -**Returns:** [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## a - -**get a**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[a](_type_misbehaviorreport_.bftatreport.md#a)* - -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45)* - -*__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## b - -**get b**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[b](_type_misbehaviorreport_.bftatreport.md#b)* - -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52)* - -*__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## round - -**get round**(): [U32](_primitive_u32_.u32.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[round](_type_misbehaviorreport_.bftatreport.md#round)* - -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59)* - -*__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.html b/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.html deleted file mode 100644 index 9518d09570..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BftDoublePropose

description: Report of a double-propose

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ BftAtReport

↳ BftDoublePropose

Implements

Constructors

constructor

⊕ new BftDoublePropose(value?: BftAtReportValue | Uint8Array): BftDoublePropose

Inherited from BftAtReport.constructor

Overrides Struct.constructor

Defined in type/MisbehaviorReport.ts:33

Parameters:

Name Type
Optional value BftAtReportValue | Uint8Array

Returns: BftDoublePropose

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

a

get a(): BftHashSignature

Inherited from BftAtReport.a

Defined in type/MisbehaviorReport.ts:45

description: The first report BftHashSignature

Returns: BftHashSignature

b

get b(): BftHashSignature

Inherited from BftAtReport.b

Defined in type/MisbehaviorReport.ts:52

description: The second report BftHashSignature

Returns: BftHashSignature

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

round

get round(): U32

Inherited from BftAtReport.round

Defined in type/MisbehaviorReport.ts:59

description: The round this report applies to as U32

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md b/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md deleted file mode 100644 index 485f58c042..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftdoublepropose.md +++ /dev/null @@ -1,495 +0,0 @@ - - -*__name__*: BftDoublePropose - -*__description__*: Report of a double-propose - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [BftAtReport](_type_misbehaviorreport_.bftatreport.md) - -**↳ BftDoublePropose** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new BftDoublePropose**(value?: *`BftAtReportValue` \| `Uint8Array`*): [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[constructor](_type_misbehaviorreport_.bftatreport.md#constructor)* - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/MisbehaviorReport.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L33)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` \| `Uint8Array` | - -**Returns:** [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## a - -**get a**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[a](_type_misbehaviorreport_.bftatreport.md#a)* - -*Defined in [type/MisbehaviorReport.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L45)* - -*__description__*: The first report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## b - -**get b**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[b](_type_misbehaviorreport_.bftatreport.md#b)* - -*Defined in [type/MisbehaviorReport.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L52)* - -*__description__*: The second report [BftHashSignature](_type_bft_.bfthashsignature.md) - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## round - -**get round**(): [U32](_primitive_u32_.u32.md) - -*Inherited from [BftAtReport](_type_misbehaviorreport_.bftatreport.md).[round](_type_misbehaviorreport_.bftatreport.md#round)* - -*Defined in [type/MisbehaviorReport.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L59)* - -*__description__*: The round this report applies to as [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html b/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html deleted file mode 100644 index 7d82210bd1..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: BftProposeOutOfTurn

description: A report for out-of-turn proposals

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ BftProposeOutOfTurn

Implements

Constructors

constructor

⊕ new BftProposeOutOfTurn(value?: BftAtReportValue | Uint8Array): BftProposeOutOfTurn

Overrides Struct.constructor

Defined in type/MisbehaviorReport.ts:69

Parameters:

Name Type
Optional value BftAtReportValue | Uint8Array

Returns: BftProposeOutOfTurn

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

a

get a(): BftHashSignature

Defined in type/MisbehaviorReport.ts:80

description: The BftHashSignature the report applies to

Returns: BftHashSignature

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

round

get round(): U32

Defined in type/MisbehaviorReport.ts:87

description: The round as [[u32]]

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md b/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md deleted file mode 100644 index ccc7728c37..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.bftproposeoutofturn.md +++ /dev/null @@ -1,474 +0,0 @@ - - -*__name__*: BftProposeOutOfTurn - -*__description__*: A report for out-of-turn proposals - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ BftProposeOutOfTurn** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new BftProposeOutOfTurn**(value?: *`BftAtReportValue` \| `Uint8Array`*): [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/MisbehaviorReport.ts:69](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L69)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` \| `Uint8Array` | - -**Returns:** [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## a - -**get a**(): [BftHashSignature](_type_bft_.bfthashsignature.md) - -*Defined in [type/MisbehaviorReport.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L80)* - -*__description__*: The [BftHashSignature](_type_bft_.bfthashsignature.md) the report applies to - -**Returns:** [BftHashSignature](_type_bft_.bfthashsignature.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## round - -**get round**(): [U32](_primitive_u32_.u32.md) - -*Defined in [type/MisbehaviorReport.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L87)* - -*__description__*: The round as \[\[u32\]\] - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.html b/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.html deleted file mode 100644 index 94623e6e29..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MisbehaviorKind

description: An EnumType containing a Bft misbehaviour

Hierarchy

↳ EnumType<BftProposeOutOfTurn | BftDoublePropose | BftDoublePrepare | BftDoubleCommit>

↳ MisbehaviorKind

Implements

Constructors

constructor

⊕ new MisbehaviorKind(value?: BftAtReportValue | Uint8Array, index?: undefined | number): MisbehaviorKind

Overrides EnumType.constructor

Defined in type/MisbehaviorReport.ts:121

Parameters:

Name Type
Optional value BftAtReportValue | Uint8Array
Optional index undefined | number

Returns: MisbehaviorKind

Accessors

asBftDoubleCommit

get asBftDoubleCommit(): BftDoubleCommit

Defined in type/MisbehaviorReport.ts:134

description: Returns the item as a BftDoubleCommit

Returns: BftDoubleCommit

asBftDoublePrepare

get asBftDoublePrepare(): BftDoublePrepare

Defined in type/MisbehaviorReport.ts:141

description: Returns the item as a BftDoublePrepare

Returns: BftDoublePrepare

asBftDoublePropose

get asBftDoublePropose(): BftDoublePropose

Defined in type/MisbehaviorReport.ts:148

description: Returns the item as a BftDoublePropose

Returns: BftDoublePropose

asBftProposeOutOfTurn

get asBftProposeOutOfTurn(): BftProposeOutOfTurn

Defined in type/MisbehaviorReport.ts:155

description: Returns the item as a BftProposeOutOfTurn

Returns: BftProposeOutOfTurn

encodedLength

get encodedLength(): number

Inherited from EnumType.encodedLength

Defined in codec/EnumType.ts:114

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): number

Inherited from EnumType.index

Defined in codec/EnumType.ts:121

description: The index of the metadata value

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from EnumType.isEmpty

Defined in codec/EnumType.ts:128

description: Checks if the value is an empty value

Returns: boolean

isNone

get isNone(): boolean

Inherited from EnumType.isNone

Defined in codec/EnumType.ts:135

description: Checks if the Enum points to a Null type

Returns: boolean

isNull

get isNull(): boolean

Inherited from EnumType.isNull

Defined in codec/EnumType.ts:142

description: Checks if the Enum points to a Null type (deprecated, use isNone)

Returns: boolean

type

get type(): string

Inherited from EnumType.type

Defined in codec/EnumType.ts:149

description: The name of the type this enum value represents

Returns: string

value

get value(): Codec

Inherited from EnumType.value

Defined in codec/EnumType.ts:156

description: The value of the enum

Returns: Codec

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from EnumType.eq

Defined in codec/EnumType.ts:163

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from EnumType.toHex

Defined in codec/EnumType.ts:176

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from EnumType.toJSON

Defined in codec/EnumType.ts:183

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from EnumType.toNumber

Defined in codec/EnumType.ts:192

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from EnumType.toString

Defined in codec/EnumType.ts:199

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from EnumType.toU8a

Defined in codec/EnumType.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> with

▸ with<S>(Types: S): EnumConstructor<EnumType<S>>

Inherited from EnumType.with

Defined in codec/EnumType.ts:101

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: EnumConstructor<EnumType<S>>

- - - diff --git a/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md b/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md deleted file mode 100644 index 7792ca402d..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.misbehaviorkind.md +++ /dev/null @@ -1,336 +0,0 @@ - - -*__name__*: MisbehaviorKind - -*__description__*: An [EnumType](_codec_enumtype_.enumtype.md) containing a Bft misbehaviour - -# Hierarchy - -↳ [EnumType](_codec_enumtype_.enumtype.md)<[BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) \| [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) \| [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) \| [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md)> - -**↳ MisbehaviorKind** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MisbehaviorKind**(value?: *`BftAtReportValue` \| `Uint8Array`*, index?: *`undefined` \| `number`*): [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) - -*Overrides [EnumType](_codec_enumtype_.enumtype.md).[constructor](_codec_enumtype_.enumtype.md#constructor)* - -*Defined in [type/MisbehaviorReport.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L121)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `BftAtReportValue` \| `Uint8Array` | -| `Optional` index | `undefined` \| `number` | - -**Returns:** [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) - -___ - -# Accessors - - - -## asBftDoubleCommit - -**get asBftDoubleCommit**(): [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) - -*Defined in [type/MisbehaviorReport.ts:134](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L134)* - -*__description__*: Returns the item as a [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) - -**Returns:** [BftDoubleCommit](_type_misbehaviorreport_.bftdoublecommit.md) - -___ - - -## asBftDoublePrepare - -**get asBftDoublePrepare**(): [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) - -*Defined in [type/MisbehaviorReport.ts:141](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L141)* - -*__description__*: Returns the item as a [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) - -**Returns:** [BftDoublePrepare](_type_misbehaviorreport_.bftdoubleprepare.md) - -___ - - -## asBftDoublePropose - -**get asBftDoublePropose**(): [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) - -*Defined in [type/MisbehaviorReport.ts:148](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L148)* - -*__description__*: Returns the item as a [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) - -**Returns:** [BftDoublePropose](_type_misbehaviorreport_.bftdoublepropose.md) - -___ - - -## asBftProposeOutOfTurn - -**get asBftProposeOutOfTurn**(): [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) - -*Defined in [type/MisbehaviorReport.ts:155](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L155)* - -*__description__*: Returns the item as a [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) - -**Returns:** [BftProposeOutOfTurn](_type_misbehaviorreport_.bftproposeoutofturn.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[encodedLength](_codec_enumtype_.enumtype.md#encodedlength)* - -*Defined in [codec/EnumType.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L114)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[index](_codec_enumtype_.enumtype.md#index)* - -*Defined in [codec/EnumType.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L121)* - -*__description__*: The index of the metadata value - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isEmpty](_codec_enumtype_.enumtype.md#isempty)* - -*Defined in [codec/EnumType.ts:128](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L128)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isNone - -**get isNone**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNone](_codec_enumtype_.enumtype.md#isnone)* - -*Defined in [codec/EnumType.ts:135](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L135)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type - -**Returns:** `boolean` - -___ - - -## isNull - -**get isNull**(): `boolean` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[isNull](_codec_enumtype_.enumtype.md#isnull)* - -*Defined in [codec/EnumType.ts:142](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L142)* - -*__description__*: Checks if the Enum points to a [Null](_primitive_null_.null.md) type (deprecated, use isNone) - -**Returns:** `boolean` - -___ - - -## type - -**get type**(): `string` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[type](_codec_enumtype_.enumtype.md#type)* - -*Defined in [codec/EnumType.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L149)* - -*__description__*: The name of the type this enum value represents - -**Returns:** `string` - -___ - - -## value - -**get value**(): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[value](_codec_enumtype_.enumtype.md#value)* - -*Defined in [codec/EnumType.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L156)* - -*__description__*: The value of the enum - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[eq](_codec_enumtype_.enumtype.md#eq)* - -*Defined in [codec/EnumType.ts:163](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L163)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toHex](_codec_enumtype_.enumtype.md#tohex)* - -*Defined in [codec/EnumType.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L176)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toJSON](_codec_enumtype_.enumtype.md#tojson)* - -*Defined in [codec/EnumType.ts:183](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L183)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toNumber](_codec_enumtype_.enumtype.md#tonumber)* - -*Defined in [codec/EnumType.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L192)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toString](_codec_enumtype_.enumtype.md#tostring)* - -*Defined in [codec/EnumType.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L199)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[toU8a](_codec_enumtype_.enumtype.md#tou8a)* - -*Defined in [codec/EnumType.ts:209](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L209)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -*Inherited from [EnumType](_codec_enumtype_.enumtype.md).[with](_codec_enumtype_.enumtype.md#with)* - -*Defined in [codec/EnumType.ts:101](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/EnumType.ts#L101)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** `EnumConstructor`<[EnumType](_codec_enumtype_.enumtype.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.html b/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.html deleted file mode 100644 index 1490ac2a26..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: MisbehaviorReport

description: A Misbehaviour report of [[MisbehavioirKind]] against a specific AuthorityId

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ MisbehaviorReport

Implements

Constructors

constructor

⊕ new MisbehaviorReport(value?: MisbehaviorReportValue | Uint8Array): MisbehaviorReport

Overrides Struct.constructor

Defined in type/MisbehaviorReport.ts:172

Parameters:

Name Type
Optional value MisbehaviorReportValue | Uint8Array

Returns: MisbehaviorReport

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

misbehavior

get misbehavior(): MisbehaviorKind

Defined in type/MisbehaviorReport.ts:185

description: The MisbehaviorKind

Returns: MisbehaviorKind

parentHash

get parentHash(): Hash

Defined in type/MisbehaviorReport.ts:192

description: The Hash of the parent block

Returns: Hash

parentNumber

get parentNumber(): BlockNumber

Defined in type/MisbehaviorReport.ts:199

description: The BlockNumber of the parent

Returns: BlockNumber

target

get target(): AuthorityId

Defined in type/MisbehaviorReport.ts:206

description: The authorityId the report applies to

Returns: AuthorityId

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md b/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md deleted file mode 100644 index ac05d1d03e..0000000000 --- a/docs/types/classes/_type_misbehaviorreport_.misbehaviorreport.md +++ /dev/null @@ -1,500 +0,0 @@ - - -*__name__*: MisbehaviorReport - -*__description__*: A Misbehaviour report of \[\[MisbehavioirKind\]\] against a specific [AuthorityId](_type_authorityid_.authorityid.md) - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ MisbehaviorReport** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new MisbehaviorReport**(value?: *`MisbehaviorReportValue` \| `Uint8Array`*): [MisbehaviorReport](_type_misbehaviorreport_.misbehaviorreport.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/MisbehaviorReport.ts:172](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L172)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `MisbehaviorReportValue` \| `Uint8Array` | - -**Returns:** [MisbehaviorReport](_type_misbehaviorreport_.misbehaviorreport.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## misbehavior - -**get misbehavior**(): [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) - -*Defined in [type/MisbehaviorReport.ts:185](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L185)* - -*__description__*: The [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) - -**Returns:** [MisbehaviorKind](_type_misbehaviorreport_.misbehaviorkind.md) - -___ - - -## parentHash - -**get parentHash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/MisbehaviorReport.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L192)* - -*__description__*: The [Hash](_type_hash_.hash.md) of the parent block - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## parentNumber - -**get parentNumber**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Defined in [type/MisbehaviorReport.ts:199](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L199)* - -*__description__*: The [BlockNumber](_type_blocknumber_.blocknumber.md) of the parent - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - - -## target - -**get target**(): [AuthorityId](_type_authorityid_.authorityid.md) - -*Defined in [type/MisbehaviorReport.ts:206](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/MisbehaviorReport.ts#L206)* - -*__description__*: The [authorityId](_type_bft_.bftauthoritysignature.md#authorityid) the report applies to - -**Returns:** [AuthorityId](_type_authorityid_.authorityid.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.html b/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.html deleted file mode 100644 index dcfa4d1224..0000000000 --- a/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: NewAccountOutcome

description: Enum to track the outcome for creation of an AccountId

Hierarchy

↳ Enum

↳ NewAccountOutcome

Implements

Constructors

constructor

⊕ new NewAccountOutcome(index?: U8a | Uint8Array | number): NewAccountOutcome

Overrides Enum.constructor

Defined in type/NewAccountOutcome.ts:13

Parameters:

Name Type
Optional index U8a | Uint8Array | number

Returns: NewAccountOutcome

Accessors

encodedLength

get encodedLength(): number

Inherited from Enum.encodedLength

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Enum.isEmpty

Defined in codec/Enum.ts:71

description: Checks if the value is an empty value (always false)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Enum.eq

Defined in codec/Enum.ts:78

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

Defined in codec/Enum.ts:91

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

Defined in codec/Enum.ts:98

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

Defined in codec/Enum.ts:105

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

Defined in codec/Enum.ts:112

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Enum.toU8a

Defined in codec/Enum.ts:120

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

Inherited from Enum.decodeEnum

Defined in codec/Enum.ts:47

Parameters:

Name Type
def EnumDef
value Enum | Uint8Array | string | number

Returns: number | undefined

- - - diff --git a/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md b/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md deleted file mode 100644 index 973e5c5f45..0000000000 --- a/docs/types/classes/_type_newaccountoutcome_.newaccountoutcome.md +++ /dev/null @@ -1,206 +0,0 @@ - - -*__name__*: NewAccountOutcome - -*__description__*: Enum to track the outcome for creation of an [AccountId](_type_accountid_.accountid.md) - -# Hierarchy - -↳ [Enum](_codec_enum_.enum.md) - -**↳ NewAccountOutcome** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new NewAccountOutcome**(index?: *[U8a](_codec_u8a_.u8a.md) \| `Uint8Array` \| `number`*): [NewAccountOutcome](_type_newaccountoutcome_.newaccountoutcome.md) - -*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* - -*Defined in [type/NewAccountOutcome.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/NewAccountOutcome.ts#L13)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` index | [U8a](_codec_u8a_.u8a.md) \| `Uint8Array` \| `number` | - -**Returns:** [NewAccountOutcome](_type_newaccountoutcome_.newaccountoutcome.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* - -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Enum](_codec_enum_.enum.md).[isEmpty](_codec_enum_.enum.md#isempty)* - -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71)* - -*__description__*: Checks if the value is an empty value (always false) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* - -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* - -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* - -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* - -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* - -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* - -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeEnum - -▸ **decodeEnum**(def: *`EnumDef`*, value: *[Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number`*): `number` \| `undefined` - -*Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* - -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| def | `EnumDef` | -| value | [Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number` | - -**Returns:** `number` \| `undefined` - -___ - diff --git a/docs/types/classes/_type_nonce_.nonce.html b/docs/types/classes/_type_nonce_.nonce.html deleted file mode 100644 index 13e21ff317..0000000000 --- a/docs/types/classes/_type_nonce_.nonce.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Nonce

description: The Nonce or number of transactions sent by a specific account. Generally used with extrinsics to determine the order of execution. implemented as a Substrate U64

Hierarchy

↳ U64

↳ Nonce

Implements

Constructors

constructor

⊕ new Nonce(value?: AnyNumber): Nonce

Inherited from U64.constructor

Overrides UInt.constructor

Defined in primitive/U64.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: Nonce

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_nonce_.nonce.md b/docs/types/classes/_type_nonce_.nonce.md deleted file mode 100644 index 8342ff8596..0000000000 --- a/docs/types/classes/_type_nonce_.nonce.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: Nonce - -*__description__*: The Nonce or number of transactions sent by a specific account. Generally used with extrinsics to determine the order of execution. implemented as a Substrate [U64](_primitive_u64_.u64.md) - -# Hierarchy - -↳ [U64](_primitive_u64_.u64.md) - -**↳ Nonce** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Nonce**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [Nonce](_type_nonce_.nonce.md) - -*Inherited from [U64](_primitive_u64_.u64.md).[constructor](_primitive_u64_.u64.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U64.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U64.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Nonce](_type_nonce_.nonce.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_noncecompact_.noncecompact.html b/docs/types/classes/_type_noncecompact_.noncecompact.html deleted file mode 100644 index bc50e84d8e..0000000000 --- a/docs/types/classes/_type_noncecompact_.noncecompact.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Nonce

description: The Compact or number of transactions sent by a specific account. Generally used with extrinsics to determine the order of execution.

Hierarchy

↳ Compact

↳ NonceCompact

Implements

Constructors

constructor

⊕ new NonceCompact(Type: Constructor<UInt | Moment>, value?: Compact | AnyNumber): NonceCompact

Inherited from Compact.constructor

Overrides Base.constructor

Defined in codec/Compact.ts:23

Parameters:

Name Type Default value
Type Constructor<UInt | Moment> -
Default value value Compact | AnyNumber 0

Returns: NonceCompact

Properties

<Static> addLengthPrefix

● addLengthPrefix: compactAddLength = compactAddLength

Inherited from Compact.addLengthPrefix

Defined in codec/Compact.ts:41

Prepend a Uint8Array with its compact length.

param: The Uint8Array to be prefixed

<Static> decodeU8a

● decodeU8a: compactFromU8a = compactFromU8a

Inherited from Compact.decodeU8a

Defined in codec/Compact.ts:42

<Static> encodeU8a

● encodeU8a: compactToU8a = compactToU8a

Inherited from Compact.encodeU8a

Defined in codec/Compact.ts:43

Accessors

encodedLength

get encodedLength(): number

Inherited from Compact.encodedLength

Defined in codec/Compact.ts:72

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Compact.isEmpty

Defined in codec/Compact.ts:79

description: Checks if the value is an empty value

Returns: boolean

Methods

bitLength

▸ bitLength(): UIntBitLength

Inherited from Compact.bitLength

Defined in codec/Compact.ts:86

description: Returns the number of bits in the value

Returns: UIntBitLength

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Compact.eq

Defined in codec/Compact.ts:93

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toBn

▸ toBn(): BN

Inherited from Compact.toBn

Defined in codec/Compact.ts:104

description: Returns the BN representation of the number

Returns: BN

toHex

▸ toHex(): any

Implementation of Codec.toHex

Inherited from Compact.toHex

Defined in codec/Compact.ts:111

description: Returns a hex string representation of the value

Returns: any

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Compact.toJSON

Defined in codec/Compact.ts:118

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from Compact.toNumber

Defined in codec/Compact.ts:125

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Compact.toString

Defined in codec/Compact.ts:132

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Compact.toU8a

Defined in codec/Compact.ts:140

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unwrap

▸ unwrap(): UInt | Moment

Inherited from Compact.unwrap

Defined in codec/Compact.ts:147

description: Returns the embedded UInt or Moment value

Returns: UInt | Moment

<Static> decodeCompact

▸ decodeCompact(Type: Constructor<UInt | Moment>, value: Compact | AnyNumber): Moment | UInt

Inherited from Compact.decodeCompact

Defined in codec/Compact.ts:51

Parameters:

Name Type
Type Constructor<UInt | Moment>
value Compact | AnyNumber

Returns: Moment | UInt

<Static> stripLengthPrefix

▸ stripLengthPrefix(u8a: Uint8Array, bitLength?: UIntBitLength): Uint8Array

Inherited from Compact.stripLengthPrefix

Defined in codec/Compact.ts:45

Parameters:

Name Type Default value
u8a Uint8Array -
Default value bitLength UIntBitLength DEFAULT_BITLENGTH

Returns: Uint8Array

<Static> with

▸ with(Type: Constructor<UInt | Moment>): Constructor<Compact>

Inherited from Compact.with

Defined in codec/Compact.ts:28

Parameters:

Name Type
Type Constructor<UInt | Moment>

Returns: Constructor<Compact>

- - - diff --git a/docs/types/classes/_type_noncecompact_.noncecompact.md b/docs/types/classes/_type_noncecompact_.noncecompact.md deleted file mode 100644 index 3983ff4277..0000000000 --- a/docs/types/classes/_type_noncecompact_.noncecompact.md +++ /dev/null @@ -1,333 +0,0 @@ - - -*__name__*: Nonce - -*__description__*: The Compact or number of transactions sent by a specific account. Generally used with extrinsics to determine the order of execution. - -# Hierarchy - -↳ [Compact](_codec_compact_.compact.md) - -**↳ NonceCompact** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new NonceCompact**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*, value?: *[Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber)*): [NonceCompact](_type_noncecompact_.noncecompact.md) - -*Inherited from [Compact](_codec_compact_.compact.md).[constructor](_codec_compact_.compact.md#constructor)* - -*Overrides [Base](_codec_base_.base.md).[constructor](_codec_base_.base.md#constructor)* - -*Defined in [codec/Compact.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L23)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)> | - | -| `Default value` value | [Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber) | 0 | - -**Returns:** [NonceCompact](_type_noncecompact_.noncecompact.md) - -___ - -# Properties - - - -## `` addLengthPrefix - -**● addLengthPrefix**: *`compactAddLength`* = compactAddLength - -*Inherited from [Compact](_codec_compact_.compact.md).[addLengthPrefix](_codec_compact_.compact.md#addlengthprefix)* - -*Defined in [codec/Compact.ts:41](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L41)* - -Prepend a Uint8Array with its compact length. - -*__param__*: The Uint8Array to be prefixed - -___ - - -## `` decodeU8a - -**● decodeU8a**: *`compactFromU8a`* = compactFromU8a - -*Inherited from [Compact](_codec_compact_.compact.md).[decodeU8a](_codec_compact_.compact.md#decodeu8a)* - -*Defined in [codec/Compact.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L42)* - -___ - - -## `` encodeU8a - -**● encodeU8a**: *`compactToU8a`* = compactToU8a - -*Inherited from [Compact](_codec_compact_.compact.md).[encodeU8a](_codec_compact_.compact.md#encodeu8a)* - -*Defined in [codec/Compact.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L43)* - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Compact](_codec_compact_.compact.md).[encodedLength](_codec_compact_.compact.md#encodedlength)* - -*Defined in [codec/Compact.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L72)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Compact](_codec_compact_.compact.md).[isEmpty](_codec_compact_.compact.md#isempty)* - -*Defined in [codec/Compact.ts:79](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L79)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - -# Methods - - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from [Compact](_codec_compact_.compact.md).[bitLength](_codec_compact_.compact.md#bitlength)* - -*Defined in [codec/Compact.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L86)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Compact](_codec_compact_.compact.md).[eq](_codec_compact_.compact.md#eq)* - -*Defined in [codec/Compact.ts:93](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L93)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from [Compact](_codec_compact_.compact.md).[toBn](_codec_compact_.compact.md#tobn)* - -*Defined in [codec/Compact.ts:104](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L104)* - -*__description__*: Returns the BN representation of the number - -**Returns:** `BN` - -___ - - -## toHex - -▸ **toHex**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Compact](_codec_compact_.compact.md).[toHex](_codec_compact_.compact.md#tohex)* - -*Defined in [codec/Compact.ts:111](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L111)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `any` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Compact](_codec_compact_.compact.md).[toJSON](_codec_compact_.compact.md#tojson)* - -*Defined in [codec/Compact.ts:118](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L118)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Compact](_codec_compact_.compact.md).[toNumber](_codec_compact_.compact.md#tonumber)* - -*Defined in [codec/Compact.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L125)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Compact](_codec_compact_.compact.md).[toString](_codec_compact_.compact.md#tostring)* - -*Defined in [codec/Compact.ts:132](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L132)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Compact](_codec_compact_.compact.md).[toU8a](_codec_compact_.compact.md#tou8a)* - -*Defined in [codec/Compact.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L140)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unwrap - -▸ **unwrap**(): [UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md) - -*Inherited from [Compact](_codec_compact_.compact.md).[unwrap](_codec_compact_.compact.md#unwrap)* - -*Defined in [codec/Compact.ts:147](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L147)* - -*__description__*: Returns the embedded [UInt](_codec_uint_.uint.md) or [Moment](_primitive_moment_.moment.md) value - -**Returns:** [UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md) - -___ - - -## `` decodeCompact - -▸ **decodeCompact**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*, value: *[Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber)*): [Moment](_primitive_moment_.moment.md) \| [UInt](_codec_uint_.uint.md) - -*Inherited from [Compact](_codec_compact_.compact.md).[decodeCompact](_codec_compact_.compact.md#decodecompact)* - -*Defined in [codec/Compact.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L51)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)> | -| value | [Compact](_codec_compact_.compact.md) \| [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Moment](_primitive_moment_.moment.md) \| [UInt](_codec_uint_.uint.md) - -___ - - -## `` stripLengthPrefix - -▸ **stripLengthPrefix**(u8a: *`Uint8Array`*, bitLength?: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*): `Uint8Array` - -*Inherited from [Compact](_codec_compact_.compact.md).[stripLengthPrefix](_codec_compact_.compact.md#striplengthprefix)* - -*Defined in [codec/Compact.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L45)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| u8a | `Uint8Array` | - | -| `Default value` bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | DEFAULT_BITLENGTH | - -**Returns:** `Uint8Array` - -___ - - -## `` with - -▸ **with**(Type: *[Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)>*): [Constructor](../interfaces/_types_.constructor.md)<[Compact](_codec_compact_.compact.md)> - -*Inherited from [Compact](_codec_compact_.compact.md).[with](_codec_compact_.compact.md#with)* - -*Defined in [codec/Compact.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Compact.ts#L28)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Type | [Constructor](../interfaces/_types_.constructor.md)<[UInt](_codec_uint_.uint.md) \| [Moment](_primitive_moment_.moment.md)> | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Compact](_codec_compact_.compact.md)> - -___ - diff --git a/docs/types/classes/_type_origin_.origin.html b/docs/types/classes/_type_origin_.origin.html deleted file mode 100644 index 39dc9b202d..0000000000 --- a/docs/types/classes/_type_origin_.origin.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Origin

description: Where Origin occurs, it should be ignored as an internal-only value, so it should never actually be constructed

Hierarchy

Null

↳ Origin

Implements

Constructors

constructor

⊕ new Origin(): Origin

Defined in type/Origin.ts:13

Returns: Origin

Accessors

encodedLength

get encodedLength(): number

Inherited from Null.encodedLength

Defined in primitive/Null.ts:17

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Null.isEmpty

Defined in primitive/Null.ts:24

description: Checks if the value is an empty value (always true)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Null.eq

Defined in primitive/Null.ts:31

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Null.toHex

Defined in primitive/Null.ts:38

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Null.toJSON

Defined in primitive/Null.ts:45

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Null.toString

Defined in primitive/Null.ts:52

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Null.toU8a

Defined in primitive/Null.ts:60

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/classes/_type_origin_.origin.md b/docs/types/classes/_type_origin_.origin.md deleted file mode 100644 index f2dd4d6d14..0000000000 --- a/docs/types/classes/_type_origin_.origin.md +++ /dev/null @@ -1,163 +0,0 @@ - - -*__name__*: Origin - -*__description__*: Where Origin occurs, it should be ignored as an internal-only value, so it should never actually be constructed - -# Hierarchy - - [Null](_primitive_null_.null.md) - -**↳ Origin** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Origin**(): [Origin](_type_origin_.origin.md) - -*Defined in [type/Origin.ts:13](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Origin.ts#L13)* - -**Returns:** [Origin](_type_origin_.origin.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Null](_primitive_null_.null.md).[encodedLength](_primitive_null_.null.md#encodedlength)* - -*Defined in [primitive/Null.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L17)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Null](_primitive_null_.null.md).[isEmpty](_primitive_null_.null.md#isempty)* - -*Defined in [primitive/Null.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L24)* - -*__description__*: Checks if the value is an empty value (always true) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Null](_primitive_null_.null.md).[eq](_primitive_null_.null.md#eq)* - -*Defined in [primitive/Null.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L31)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Null](_primitive_null_.null.md).[toHex](_primitive_null_.null.md#tohex)* - -*Defined in [primitive/Null.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L38)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Null](_primitive_null_.null.md).[toJSON](_primitive_null_.null.md#tojson)* - -*Defined in [primitive/Null.ts:45](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L45)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Null](_primitive_null_.null.md).[toString](_primitive_null_.null.md#tostring)* - -*Defined in [primitive/Null.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L52)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Null](_primitive_null_.null.md).[toU8a](_primitive_null_.null.md#tou8a)* - -*Defined in [primitive/Null.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Null.ts#L60)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/classes/_type_paraid_.paraid.html b/docs/types/classes/_type_paraid_.paraid.html deleted file mode 100644 index 5885b245d3..0000000000 --- a/docs/types/classes/_type_paraid_.paraid.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ParaId

description: Identifier for a deployed parachain implemented as a U32

Hierarchy

↳ U32

↳ ParaId

Implements

Constructors

constructor

⊕ new ParaId(value?: AnyNumber): ParaId

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: ParaId

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_paraid_.paraid.md b/docs/types/classes/_type_paraid_.paraid.md deleted file mode 100644 index b27e6a9f4c..0000000000 --- a/docs/types/classes/_type_paraid_.paraid.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: ParaId - -*__description__*: Identifier for a deployed parachain implemented as a [U32](_primitive_u32_.u32.md) - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ ParaId** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ParaId**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [ParaId](_type_paraid_.paraid.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [ParaId](_type_paraid_.paraid.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_perbill_.perbill.html b/docs/types/classes/_type_perbill_.perbill.html deleted file mode 100644 index 358cd421b1..0000000000 --- a/docs/types/classes/_type_perbill_.perbill.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Perbill

description: Parts per billion (see also Permill)

Hierarchy

↳ U32

↳ Perbill

Implements

Constructors

constructor

⊕ new Perbill(value?: AnyNumber): Perbill

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: Perbill

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_perbill_.perbill.md b/docs/types/classes/_type_perbill_.perbill.md deleted file mode 100644 index 18de1b60b7..0000000000 --- a/docs/types/classes/_type_perbill_.perbill.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: Perbill - -*__description__*: Parts per billion (see also [Permill](_type_permill_.permill.md)) - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ Perbill** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Perbill**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [Perbill](_type_perbill_.perbill.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Perbill](_type_perbill_.perbill.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_permill_.permill.html b/docs/types/classes/_type_permill_.permill.html deleted file mode 100644 index c4d431af99..0000000000 --- a/docs/types/classes/_type_permill_.permill.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Permill

description: Parts per million (See also Perbill)

Hierarchy

↳ U32

↳ Permill

Implements

Constructors

constructor

⊕ new Permill(value?: AnyNumber): Permill

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: Permill

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_permill_.permill.md b/docs/types/classes/_type_permill_.permill.md deleted file mode 100644 index f519ad2105..0000000000 --- a/docs/types/classes/_type_permill_.permill.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: Permill - -*__description__*: Parts per million (See also [Perbill](_type_perbill_.perbill.md)) - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ Permill** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Permill**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [Permill](_type_permill_.permill.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [Permill](_type_permill_.permill.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html b/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html deleted file mode 100644 index 649332d73b..0000000000 --- a/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: PrefabWasmModule

description: Struct to encode the vesting schedule of an individual account

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ PrefabWasmModule

Implements

Constructors

constructor

⊕ new PrefabWasmModule(value?: any): PrefabWasmModule

Overrides Struct.constructor

Defined in type/PrefabWasmModule.ts:19

Parameters:

Name Type
Optional value any

Returns: PrefabWasmModule

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

code

get code(): Bytes

Defined in type/PrefabWasmModule.ts:33

description: The code as Bytes

Returns: Bytes

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

initial

get initial(): Compact

Defined in type/PrefabWasmModule.ts:40

description: The initial as Compact

Returns: Compact

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

maximum

get maximum(): Compact

Defined in type/PrefabWasmModule.ts:47

description: The maximum as Compact

Returns: Compact

scheduleVersion

get scheduleVersion(): Compact

Defined in type/PrefabWasmModule.ts:54

description: The scheduleVersion value as Compact

Returns: Compact

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md b/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md deleted file mode 100644 index 6af5eb028d..0000000000 --- a/docs/types/classes/_type_prefabwasmmodule_.prefabwasmmodule.md +++ /dev/null @@ -1,500 +0,0 @@ - - -*__name__*: PrefabWasmModule - -*__description__*: Struct to encode the vesting schedule of an individual account - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ PrefabWasmModule** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new PrefabWasmModule**(value?: *`any`*): [PrefabWasmModule](_type_prefabwasmmodule_.prefabwasmmodule.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/PrefabWasmModule.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L19)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [PrefabWasmModule](_type_prefabwasmmodule_.prefabwasmmodule.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## code - -**get code**(): [Bytes](_primitive_bytes_.bytes.md) - -*Defined in [type/PrefabWasmModule.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L33)* - -*__description__*: The code as [Bytes](_primitive_bytes_.bytes.md) - -**Returns:** [Bytes](_primitive_bytes_.bytes.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## initial - -**get initial**(): [Compact](_codec_compact_.compact.md) - -*Defined in [type/PrefabWasmModule.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L40)* - -*__description__*: The initial as [Compact](_codec_compact_.compact.md) - -**Returns:** [Compact](_codec_compact_.compact.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## maximum - -**get maximum**(): [Compact](_codec_compact_.compact.md) - -*Defined in [type/PrefabWasmModule.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L47)* - -*__description__*: The maximum as [Compact](_codec_compact_.compact.md) - -**Returns:** [Compact](_codec_compact_.compact.md) - -___ - - -## scheduleVersion - -**get scheduleVersion**(): [Compact](_codec_compact_.compact.md) - -*Defined in [type/PrefabWasmModule.ts:54](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/PrefabWasmModule.ts#L54)* - -*__description__*: The scheduleVersion value as [Compact](_codec_compact_.compact.md) - -**Returns:** [Compact](_codec_compact_.compact.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_propindex_.propindex.html b/docs/types/classes/_type_propindex_.propindex.html deleted file mode 100644 index b8c3cd717a..0000000000 --- a/docs/types/classes/_type_propindex_.propindex.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: PropIndex

description: An increasing number that represents a specific public proposal index in the system, implemented as a U32

Hierarchy

↳ U32

↳ PropIndex

Implements

Constructors

constructor

⊕ new PropIndex(value?: AnyNumber): PropIndex

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: PropIndex

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_propindex_.propindex.md b/docs/types/classes/_type_propindex_.propindex.md deleted file mode 100644 index 4d34af13d8..0000000000 --- a/docs/types/classes/_type_propindex_.propindex.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: PropIndex - -*__description__*: An increasing number that represents a specific public proposal index in the system, implemented as a [U32](_primitive_u32_.u32.md) - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ PropIndex** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new PropIndex**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [PropIndex](_type_propindex_.propindex.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [PropIndex](_type_propindex_.propindex.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_proposal_.proposal.html b/docs/types/classes/_type_proposal_.proposal.html deleted file mode 100644 index 38f5e9bf55..0000000000 --- a/docs/types/classes/_type_proposal_.proposal.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Proposal

description: A proposal in the system. It just extends Method (Proposal = Call in Rust)

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Method

↳ Proposal

Implements

Constructors

constructor

⊕ new Proposal(value: any, meta?: FunctionMetadata): Proposal

Inherited from Method.constructor

Overrides Struct.constructor

Defined in primitive/Method.ts:70

Parameters:

Name Type
value any
Optional meta FunctionMetadata

Returns: Proposal

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

args

get args(): Array<Codec>

Inherited from Method.args

Defined in primitive/Method.ts:192

description: The arguments for the function call

Returns: Array<Codec>

argsDef

get argsDef(): ArgsDef

Inherited from Method.argsDef

Defined in primitive/Method.ts:200

description: Thge argument defintions

Returns: ArgsDef

callIndex

get callIndex(): Uint8Array

Inherited from Method.callIndex

Defined in primitive/Method.ts:207

description: The encoded [sectionIndex, methodIndex] identifier

Returns: Uint8Array

data

get data(): Uint8Array

Inherited from Method.data

Defined in primitive/Method.ts:214

description: The encoded data

Returns: Uint8Array

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

hasOrigin

get hasOrigin(): boolean

Inherited from Method.hasOrigin

Defined in primitive/Method.ts:221

description: true if the Origin type is on the method (extrinsic method)

Returns: boolean

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

meta

get meta(): FunctionMetadata

Inherited from Method.meta

Defined in primitive/Method.ts:230

description: The FunctionMetadata

Returns: FunctionMetadata

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> filterOrigin

▸ filterOrigin(meta?: FunctionMetadata): Array<FunctionArgumentMetadata>

Inherited from Method.filterOrigin

Defined in primitive/Method.ts:140

Parameters:

Name Type
Optional meta FunctionMetadata

Returns: Array<FunctionArgumentMetadata>

<Static> findFunction

▸ findFunction(callIndex: Uint8Array): MethodFunction

Inherited from Method.findFunction

Defined in primitive/Method.ts:156

Parameters:

Name Type
callIndex Uint8Array

Returns: MethodFunction

<Static> injectMethods

▸ injectMethods(moduleMethods: ModulesWithMethods): void

Inherited from Method.injectMethods

Defined in primitive/Method.ts:181

Parameters:

Name Type
moduleMethods ModulesWithMethods

Returns: void

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_proposal_.proposal.md b/docs/types/classes/_type_proposal_.proposal.md deleted file mode 100644 index 4293ca7b79..0000000000 --- a/docs/types/classes/_type_proposal_.proposal.md +++ /dev/null @@ -1,598 +0,0 @@ - - -*__name__*: Proposal - -*__description__*: A proposal in the system. It just extends [Method](_primitive_method_.method.md) (Proposal = Call in Rust) - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Method](_primitive_method_.method.md) - -**↳ Proposal** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Proposal**(value: *`any`*, meta?: *[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)*): [Proposal](_type_proposal_.proposal.md) - -*Inherited from [Method](_primitive_method_.method.md).[constructor](_primitive_method_.method.md#constructor)* - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [primitive/Method.ts:70](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L70)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `any` | -| `Optional` meta | [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) | - -**Returns:** [Proposal](_type_proposal_.proposal.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## args - -**get args**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Method](_primitive_method_.method.md).[args](_primitive_method_.method.md#args)* - -*Defined in [primitive/Method.ts:192](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L192)* - -*__description__*: The arguments for the function call - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## argsDef - -**get argsDef**(): `ArgsDef` - -*Inherited from [Method](_primitive_method_.method.md).[argsDef](_primitive_method_.method.md#argsdef)* - -*Defined in [primitive/Method.ts:200](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L200)* - -*__description__*: Thge argument defintions - -**Returns:** `ArgsDef` - -___ - - -## callIndex - -**get callIndex**(): `Uint8Array` - -*Inherited from [Method](_primitive_method_.method.md).[callIndex](_primitive_method_.method.md#callindex)* - -*Defined in [primitive/Method.ts:207](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L207)* - -*__description__*: The encoded `[sectionIndex, methodIndex]` identifier - -**Returns:** `Uint8Array` - -___ - - -## data - -**get data**(): `Uint8Array` - -*Inherited from [Method](_primitive_method_.method.md).[data](_primitive_method_.method.md#data)* - -*Defined in [primitive/Method.ts:214](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L214)* - -*__description__*: The encoded data - -**Returns:** `Uint8Array` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## hasOrigin - -**get hasOrigin**(): `boolean` - -*Inherited from [Method](_primitive_method_.method.md).[hasOrigin](_primitive_method_.method.md#hasorigin)* - -*Defined in [primitive/Method.ts:221](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L221)* - -*__description__*: `true` if the `Origin` type is on the method (extrinsic method) - -**Returns:** `boolean` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## meta - -**get meta**(): [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -*Inherited from [Method](_primitive_method_.method.md).[meta](_primitive_method_.method.md#meta)* - -*Defined in [primitive/Method.ts:230](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L230)* - -*__description__*: The [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -**Returns:** [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` filterOrigin - -▸ **filterOrigin**(meta?: *[FunctionMetadata](_metadata_v0_modules_.functionmetadata.md)*): `Array`<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> - -*Inherited from [Method](_primitive_method_.method.md).[filterOrigin](_primitive_method_.method.md#filterorigin)* - -*Defined in [primitive/Method.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L140)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` meta | [FunctionMetadata](_metadata_v0_modules_.functionmetadata.md) | - -**Returns:** `Array`<[FunctionArgumentMetadata](_metadata_v0_modules_.functionargumentmetadata.md)> - -___ - - -## `` findFunction - -▸ **findFunction**(callIndex: *`Uint8Array`*): [MethodFunction](../interfaces/_primitive_method_.methodfunction.md) - -*Inherited from [Method](_primitive_method_.method.md).[findFunction](_primitive_method_.method.md#findfunction)* - -*Defined in [primitive/Method.ts:156](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L156)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callIndex | `Uint8Array` | - -**Returns:** [MethodFunction](../interfaces/_primitive_method_.methodfunction.md) - -___ - - -## `` injectMethods - -▸ **injectMethods**(moduleMethods: *[ModulesWithMethods](../interfaces/_primitive_method_.moduleswithmethods.md)*): `void` - -*Inherited from [Method](_primitive_method_.method.md).[injectMethods](_primitive_method_.method.md#injectmethods)* - -*Defined in [primitive/Method.ts:181](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L181)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| moduleMethods | [ModulesWithMethods](../interfaces/_primitive_method_.moduleswithmethods.md) | - -**Returns:** `void` - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_proposalindex_.proposalindex.html b/docs/types/classes/_type_proposalindex_.proposalindex.html deleted file mode 100644 index 122e55b379..0000000000 --- a/docs/types/classes/_type_proposalindex_.proposalindex.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ProposalIndex

description: An increasing number that represents a specific council proposal index in the system, implemented as U32

Hierarchy

↳ U32

↳ ProposalIndex

Implements

Constructors

constructor

⊕ new ProposalIndex(value?: AnyNumber): ProposalIndex

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: ProposalIndex

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_proposalindex_.proposalindex.md b/docs/types/classes/_type_proposalindex_.proposalindex.md deleted file mode 100644 index 9c2dbd070e..0000000000 --- a/docs/types/classes/_type_proposalindex_.proposalindex.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: ProposalIndex - -*__description__*: An increasing number that represents a specific council proposal index in the system, implemented as [U32](_primitive_u32_.u32.md) - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ ProposalIndex** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ProposalIndex**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [ProposalIndex](_type_proposalindex_.proposalindex.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [ProposalIndex](_type_proposalindex_.proposalindex.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_referendumindex_.referendumindex.html b/docs/types/classes/_type_referendumindex_.referendumindex.html deleted file mode 100644 index 3431a97264..0000000000 --- a/docs/types/classes/_type_referendumindex_.referendumindex.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ReferendumIndex

description: An increasing number that represents a specific referendum in the system. It is unique per chain. Implemented as U32

Hierarchy

↳ U32

↳ ReferendumIndex

Implements

Constructors

constructor

⊕ new ReferendumIndex(value?: AnyNumber): ReferendumIndex

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: ReferendumIndex

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_referendumindex_.referendumindex.md b/docs/types/classes/_type_referendumindex_.referendumindex.md deleted file mode 100644 index 6ff635602f..0000000000 --- a/docs/types/classes/_type_referendumindex_.referendumindex.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: ReferendumIndex - -*__description__*: An increasing number that represents a specific referendum in the system. It is unique per chain. Implemented as [U32](_primitive_u32_.u32.md) - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ ReferendumIndex** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ReferendumIndex**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [ReferendumIndex](_type_referendumindex_.referendumindex.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [ReferendumIndex](_type_referendumindex_.referendumindex.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_referenduminfo_.referenduminfo.html b/docs/types/classes/_type_referenduminfo_.referenduminfo.html deleted file mode 100644 index c95e5f8159..0000000000 --- a/docs/types/classes/_type_referenduminfo_.referenduminfo.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ReferendumInfo

description: Info regarding an ongoing referendum

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ ReferendumInfo

Implements

Constructors

constructor

⊕ new ReferendumInfo(value?: ReferendumInfoValue | Uint8Array | Map<string, Codec>): ReferendumInfo

Overrides Struct.constructor

Defined in type/ReferendumInfo.ts:24

Parameters:

Name Type
Optional value ReferendumInfoValue | Uint8Array | Map<string, Codec>

Returns: ReferendumInfo

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

delay

get delay(): BlockNumber

Defined in type/ReferendumInfo.ts:58

description: The delay (in blocks) to wait after a successful referendum before deploying

Returns: BlockNumber

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

end

get end(): BlockNumber

Defined in type/ReferendumInfo.ts:37

description: When voting on this referendum will end

Returns: BlockNumber

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

proposal

get proposal(): Proposal

Defined in type/ReferendumInfo.ts:44

description: The proposal being voted on

Returns: Proposal

threshold

get threshold(): VoteThreshold

Defined in type/ReferendumInfo.ts:51

description: The thresholding mechanism to determine whether it passed

Returns: VoteThreshold

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_referenduminfo_.referenduminfo.md b/docs/types/classes/_type_referenduminfo_.referenduminfo.md deleted file mode 100644 index d041ae25f0..0000000000 --- a/docs/types/classes/_type_referenduminfo_.referenduminfo.md +++ /dev/null @@ -1,500 +0,0 @@ - - -*__name__*: ReferendumInfo - -*__description__*: Info regarding an ongoing referendum - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ ReferendumInfo** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ReferendumInfo**(value?: *`ReferendumInfoValue` \| `Uint8Array` \| `Map`<`string`, [Codec](../interfaces/_types_.codec.md)>*): [ReferendumInfo](_type_referenduminfo_.referenduminfo.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/ReferendumInfo.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L24)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `ReferendumInfoValue` \| `Uint8Array` \| `Map`<`string`, [Codec](../interfaces/_types_.codec.md)> | - -**Returns:** [ReferendumInfo](_type_referenduminfo_.referenduminfo.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## delay - -**get delay**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Defined in [type/ReferendumInfo.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L58)* - -*__description__*: The delay (in blocks) to wait after a successful referendum before deploying - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## end - -**get end**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Defined in [type/ReferendumInfo.ts:37](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L37)* - -*__description__*: When voting on this referendum will end - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## proposal - -**get proposal**(): [Proposal](_type_proposal_.proposal.md) - -*Defined in [type/ReferendumInfo.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L44)* - -*__description__*: The proposal being voted on - -**Returns:** [Proposal](_type_proposal_.proposal.md) - -___ - - -## threshold - -**get threshold**(): [VoteThreshold](_type_votethreshold_.votethreshold.md) - -*Defined in [type/ReferendumInfo.ts:51](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ReferendumInfo.ts#L51)* - -*__description__*: The thresholding mechanism to determine whether it passed - -**Returns:** [VoteThreshold](_type_votethreshold_.votethreshold.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_schedule_.schedule.html b/docs/types/classes/_type_schedule_.schedule.html deleted file mode 100644 index d9816a3813..0000000000 --- a/docs/types/classes/_type_schedule_.schedule.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Schedule

description: Definition of the cost schedule and other parameterizations for wasm vm

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Schedule

Implements

Constructors

constructor

⊕ new Schedule(value?: any): Schedule

Overrides Struct.constructor

Defined in type/Schedule.ts:14

Parameters:

Name Type
Optional value any

Returns: Schedule

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

growMemCost

get growMemCost(): Gas

Defined in type/Schedule.ts:32

description: Gas cost of a growing memory by single page.

Returns: Gas

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

maxMemoryPages

get maxMemoryPages(): U32

Defined in type/Schedule.ts:39

description: What is the maximal memory pages amount is allowed to have for a contract.

Returns: U32

maxStackHeight

get maxStackHeight(): U32

Defined in type/Schedule.ts:46

description: How tall the stack is allowed to grow?

Returns: U32

putCodePerByteCost

get putCodePerByteCost(): Gas

Defined in type/Schedule.ts:53

description: Cost of putting a byte of code into the storage.

Returns: Gas

regularOpCost

get regularOpCost(): Gas

Defined in type/Schedule.ts:60

description: Gas cost of a regular operation.

Returns: Gas

returnDataPerByteCost

get returnDataPerByteCost(): Gas

Defined in type/Schedule.ts:67

description: Gas cost per one byte returned.

Returns: Gas

sandboxDataReadCost

get sandboxDataReadCost(): Gas

Defined in type/Schedule.ts:74

description: Gas cost per one byte read from the sandbox memory.

Returns: Gas

sandboxDataWriteCost

get sandboxDataWriteCost(): Gas

Defined in type/Schedule.ts:81

description: Gas cost per one byte written to the sandbox memory.

Returns: Gas

version

get version(): U32

Defined in type/Schedule.ts:88

description: Version of the schedule.

Returns: U32

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_schedule_.schedule.md b/docs/types/classes/_type_schedule_.schedule.md deleted file mode 100644 index 8906d91dd1..0000000000 --- a/docs/types/classes/_type_schedule_.schedule.md +++ /dev/null @@ -1,565 +0,0 @@ - - -*__name__*: Schedule - -*__description__*: Definition of the cost schedule and other parameterizations for wasm vm - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ Schedule** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Schedule**(value?: *`any`*): [Schedule](_type_schedule_.schedule.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/Schedule.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [Schedule](_type_schedule_.schedule.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## growMemCost - -**get growMemCost**(): [Gas](_type_gas_.gas.md) - -*Defined in [type/Schedule.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L32)* - -*__description__*: Gas cost of a growing memory by single page. - -**Returns:** [Gas](_type_gas_.gas.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## maxMemoryPages - -**get maxMemoryPages**(): [U32](_primitive_u32_.u32.md) - -*Defined in [type/Schedule.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L39)* - -*__description__*: What is the maximal memory pages amount is allowed to have for a contract. - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - - -## maxStackHeight - -**get maxStackHeight**(): [U32](_primitive_u32_.u32.md) - -*Defined in [type/Schedule.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L46)* - -*__description__*: How tall the stack is allowed to grow? - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - - -## putCodePerByteCost - -**get putCodePerByteCost**(): [Gas](_type_gas_.gas.md) - -*Defined in [type/Schedule.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L53)* - -*__description__*: Cost of putting a byte of code into the storage. - -**Returns:** [Gas](_type_gas_.gas.md) - -___ - - -## regularOpCost - -**get regularOpCost**(): [Gas](_type_gas_.gas.md) - -*Defined in [type/Schedule.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L60)* - -*__description__*: Gas cost of a regular operation. - -**Returns:** [Gas](_type_gas_.gas.md) - -___ - - -## returnDataPerByteCost - -**get returnDataPerByteCost**(): [Gas](_type_gas_.gas.md) - -*Defined in [type/Schedule.ts:67](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L67)* - -*__description__*: Gas cost per one byte returned. - -**Returns:** [Gas](_type_gas_.gas.md) - -___ - - -## sandboxDataReadCost - -**get sandboxDataReadCost**(): [Gas](_type_gas_.gas.md) - -*Defined in [type/Schedule.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L74)* - -*__description__*: Gas cost per one byte read from the sandbox memory. - -**Returns:** [Gas](_type_gas_.gas.md) - -___ - - -## sandboxDataWriteCost - -**get sandboxDataWriteCost**(): [Gas](_type_gas_.gas.md) - -*Defined in [type/Schedule.ts:81](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L81)* - -*__description__*: Gas cost per one byte written to the sandbox memory. - -**Returns:** [Gas](_type_gas_.gas.md) - -___ - - -## version - -**get version**(): [U32](_primitive_u32_.u32.md) - -*Defined in [type/Schedule.ts:88](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Schedule.ts#L88)* - -*__description__*: Version of the schedule. - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_seedof_.seedof.html b/docs/types/classes/_type_seedof_.seedof.html deleted file mode 100644 index 9926d3a5a3..0000000000 --- a/docs/types/classes/_type_seedof_.seedof.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: SeedOf

description: The Substrate SeedOf representation as a Hash.

Hierarchy

↳ Hash

↳ SeedOf

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new SeedOf(value?: AnyU8a): SeedOf

Inherited from H256.constructor

Overrides U8aFixed.constructor

Defined in primitive/H256.ts:15

Parameters:

Name Type
Optional value AnyU8a

Returns: SeedOf

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_seedof_.seedof.md b/docs/types/classes/_type_seedof_.seedof.md deleted file mode 100644 index 18fd2c2bce..0000000000 --- a/docs/types/classes/_type_seedof_.seedof.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: SeedOf - -*__description__*: The Substrate SeedOf representation as a [Hash](_type_hash_.hash.md). - -# Hierarchy - -↳ [Hash](_type_hash_.hash.md) - -**↳ SeedOf** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new SeedOf**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [SeedOf](_type_seedof_.seedof.md) - -*Inherited from [H256](_primitive_h256_.h256.md).[constructor](_primitive_h256_.h256.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H256.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H256.ts#L15)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [SeedOf](_type_seedof_.seedof.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_sessionkey_.sessionkey.html b/docs/types/classes/_type_sessionkey_.sessionkey.html deleted file mode 100644 index 1a69a86ebf..0000000000 --- a/docs/types/classes/_type_sessionkey_.sessionkey.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: SessionKey

description: Wrapper for a SessionKey. Same as an normal AuthorityId, i.e. a wrapper around publicKey.

Hierarchy

↳ AuthorityId

↳ SessionKey

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new SessionKey(value?: AnyU8a): SessionKey

Inherited from AccountId.constructor

Overrides U8aFixed.constructor

Defined in type/AccountId.ts:19

Parameters:

Name Type Default value
Default value value AnyU8a new Uint8Array()

Returns: SessionKey

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AccountId.eq

Overrides U8a.eq

Defined in type/AccountId.ts:46

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AccountId.toJSON

Overrides U8a.toJSON

Defined in type/AccountId.ts:53

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from AccountId.toString

Overrides U8a.toString

Defined in type/AccountId.ts:60

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

<Static> encode

▸ encode(value: Uint8Array): string

Inherited from AccountId.encode

Defined in type/AccountId.ts:27

Parameters:

Name Type
value Uint8Array

Returns: string

- - - diff --git a/docs/types/classes/_type_sessionkey_.sessionkey.md b/docs/types/classes/_type_sessionkey_.sessionkey.md deleted file mode 100644 index d565137898..0000000000 --- a/docs/types/classes/_type_sessionkey_.sessionkey.md +++ /dev/null @@ -1,875 +0,0 @@ - - -*__name__*: SessionKey - -*__description__*: Wrapper for a SessionKey. Same as an normal [AuthorityId](_type_authorityid_.authorityid.md), i.e. a wrapper around publicKey. - -# Hierarchy - -↳ [AuthorityId](_type_authorityid_.authorityid.md) - -**↳ SessionKey** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new SessionKey**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [SessionKey](_type_sessionkey_.sessionkey.md) - -*Inherited from [AccountId](_type_accountid_.accountid.md).[constructor](_type_accountid_.accountid.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [type/AccountId.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L19)* - -**Parameters:** - -| Name | Type | Default value | -| ------ | ------ | ------ | -| `Default value` value | [AnyU8a](../modules/_types_.md#anyu8a) | new Uint8Array() | - -**Returns:** [SessionKey](_type_sessionkey_.sessionkey.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[eq](_type_accountid_.accountid.md#eq)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [type/AccountId.ts:46](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L46)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[toJSON](_type_accountid_.accountid.md#tojson)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [type/AccountId.ts:53](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L53)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [AccountId](_type_accountid_.accountid.md).[toString](_type_accountid_.accountid.md#tostring)* - -*Overrides [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Defined in [type/AccountId.ts:60](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L60)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## `` encode - -▸ **encode**(value: *`Uint8Array`*): `string` - -*Inherited from [AccountId](_type_accountid_.accountid.md).[encode](_type_accountid_.accountid.md#encode)* - -*Defined in [type/AccountId.ts:27](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountId.ts#L27)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | `Uint8Array` | - -**Returns:** `string` - -___ - diff --git a/docs/types/classes/_type_signature_.ed25519signature.html b/docs/types/classes/_type_signature_.ed25519signature.html deleted file mode 100644 index da68a0da1d..0000000000 --- a/docs/types/classes/_type_signature_.ed25519signature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Ed25519Signature

description: The default Ed25519 that is used accross the system. It is currectly defined as a 512-bit value, represented by a H512.

Hierarchy

↳ Signature

↳ Ed25519Signature

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Ed25519Signature(value?: AnyU8a): Ed25519Signature

Inherited from H512.constructor

Overrides U8aFixed.constructor

Defined in primitive/H512.ts:14

Parameters:

Name Type
Optional value AnyU8a

Returns: Ed25519Signature

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_signature_.ed25519signature.md b/docs/types/classes/_type_signature_.ed25519signature.md deleted file mode 100644 index 3cd21413ba..0000000000 --- a/docs/types/classes/_type_signature_.ed25519signature.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: Ed25519Signature - -*__description__*: The default Ed25519 that is used accross the system. It is currectly defined as a 512-bit value, represented by a [H512](_primitive_h512_.h512.md). - -# Hierarchy - -↳ [Signature](_type_signature_.signature.md) - -**↳ Ed25519Signature** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Ed25519Signature**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Ed25519Signature](_type_signature_.ed25519signature.md) - -*Inherited from [H512](_primitive_h512_.h512.md).[constructor](_primitive_h512_.h512.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Ed25519Signature](_type_signature_.ed25519signature.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_signature_.signature.html b/docs/types/classes/_type_signature_.signature.html deleted file mode 100644 index b36082f8c5..0000000000 --- a/docs/types/classes/_type_signature_.signature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Signature

description: The default signature that is used accross the system. It is currectly defined as a 512-bit value, represented by a H512.

Hierarchy

↳ H512

↳ Signature

↳ Ed25519Signature

↳ Sr25519Signature

↳ CandidateSignature

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Signature(value?: AnyU8a): Signature

Inherited from H512.constructor

Overrides U8aFixed.constructor

Defined in primitive/H512.ts:14

Parameters:

Name Type
Optional value AnyU8a

Returns: Signature

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_signature_.signature.md b/docs/types/classes/_type_signature_.signature.md deleted file mode 100644 index 0077283f49..0000000000 --- a/docs/types/classes/_type_signature_.signature.md +++ /dev/null @@ -1,858 +0,0 @@ - - -*__name__*: Signature - -*__description__*: The default signature that is used accross the system. It is currectly defined as a 512-bit value, represented by a [H512](_primitive_h512_.h512.md). - -# Hierarchy - -↳ [H512](_primitive_h512_.h512.md) - -**↳ Signature** - -↳ [Ed25519Signature](_type_signature_.ed25519signature.md) - -↳ [Sr25519Signature](_type_signature_.sr25519signature.md) - -↳ [CandidateSignature](_type_attestedcandidate_.candidatesignature.md) - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Signature**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Signature](_type_signature_.signature.md) - -*Inherited from [H512](_primitive_h512_.h512.md).[constructor](_primitive_h512_.h512.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Signature](_type_signature_.signature.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_signature_.sr25519signature.html b/docs/types/classes/_type_signature_.sr25519signature.html deleted file mode 100644 index 9cd8d79fd5..0000000000 --- a/docs/types/classes/_type_signature_.sr25519signature.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Sr25519Signature

description: The default Sr25519 signature that is used accross the system. It is currectly defined as a 512-bit value, represented by a H512.

Hierarchy

↳ Signature

↳ Sr25519Signature

Implements

Indexable

[index: number]: number

Constructors

constructor

⊕ new Sr25519Signature(value?: AnyU8a): Sr25519Signature

Inherited from H512.constructor

Overrides U8aFixed.constructor

Defined in primitive/H512.ts:14

Parameters:

Name Type
Optional value AnyU8a

Returns: Sr25519Signature

Properties

BYTES_PER_ELEMENT

● BYTES_PER_ELEMENT: number

Inherited from Uint8Array.BYTES_PER_ELEMENT

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962

The size in bytes of each element in the array.

__@toStringTag

● __@toStringTag: "UInt8Array"

Inherited from Uint8Array.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276

buffer

● buffer: ArrayBufferLike

Inherited from Uint8Array.buffer

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967

The ArrayBuffer instance referenced by the array.

byteLength

● byteLength: number

Inherited from Uint8Array.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972

The length in bytes of the array.

byteOffset

● byteOffset: number

Inherited from Uint8Array.byteOffset

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977

The offset in bytes of the array.

Accessors

encodedLength

get encodedLength(): number

Inherited from U8a.encodedLength

Defined in codec/U8a.ts:36

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from U8a.isEmpty

Defined in codec/U8a.ts:43

description: Returns true if the type wraps an empty/default all-0 value

Returns: boolean

length

get length(): number

Inherited from U8a.length

Overrides Uint8Array.length

Defined in codec/U8a.ts:50

description: The length of the value

Returns: number

Methods

__@iterator

▸ __@iterator(): IterableIterator<number>

Inherited from Uint8Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267

Returns: IterableIterator<number>

bitLength

▸ bitLength(): number

Inherited from U8aFixed.bitLength

Defined in codec/U8aFixed.ts:52

description: Returns the number of bits in the value

Returns: number

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Uint8Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, number]>

Inherited from Uint8Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271

Returns an array of key, value pairs for every entry in the array

Returns: IterableIterator<[number, number]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from U8a.eq

Defined in codec/U8a.ts:58

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: number, start?: undefined | number, end?: undefined | number): this

Inherited from Uint8Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value number value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.filter

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017

Returns the elements of an array that meet the condition specified in a callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

find

▸ find(predicate: function, thisArg?: any): number | undefined

Inherited from Uint8Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Uint8Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Uint8Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: number, fromIndex?: undefined | number): boolean

Inherited from Uint8Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement number The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Uint8Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Uint8Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275

Returns an list of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: number, fromIndex?: undefined | number): number

Inherited from Uint8Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071

Returns the index of the last occurrence of a value in an array.

Parameters:

Name Type Description
searchElement number The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

map

▸ map(callbackfn: function, thisArg?: any): Uint8Array

Inherited from Uint8Array.map

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: Uint8Array

reduce

▸ reduce(callbackfn: function): number

▸ reduce(callbackfn: function, initialValue: number): number

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): number

▸ reduceRight(callbackfn: function, initialValue: number): number

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124

Parameters:

Name Type
callbackfn function
initialValue number

Returns: number

Inherited from Uint8Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Uint8Array

Inherited from Uint8Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141

Reverses the elements in an Array.

Returns: Uint8Array

set

▸ set(array: ArrayLike<number>, offset?: undefined | number): void

Inherited from Uint8Array.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148

Sets a value or an array of values.

Parameters:

Name Type Description
array ArrayLike<number> A typed or untyped array of values to set.
Optional offset undefined | number The index in the current array at which the values are to be written.

Returns: void

slice

▸ slice(start?: undefined | number, end?: undefined | number): Uint8Array

Inherited from Uint8Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Uint8Array

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Uint8Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Uint8Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

subarray

▸ subarray(begin: number, end?: undefined | number): Uint8Array

Inherited from U8a.subarray

Overrides Uint8Array.subarray

Defined in codec/U8a.ts:73

description: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here

Parameters:

Name Type Description
begin number The position to start at
Optional end undefined | number The position to end at

Returns: Uint8Array

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from U8a.toHex

Defined in codec/U8a.ts:80

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from U8a.toJSON

Defined in codec/U8a.ts:87

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Uint8Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185

Converts a number to a string by using the current locale.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from U8a.toString

Overrides Uint8Array.toString

Defined in codec/U8a.ts:94

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from U8a.toU8a

Defined in codec/U8a.ts:102

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<number>

Inherited from Uint8Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279

Returns an list of values in the array

Returns: IterableIterator<number>

- - - diff --git a/docs/types/classes/_type_signature_.sr25519signature.md b/docs/types/classes/_type_signature_.sr25519signature.md deleted file mode 100644 index 7d8cea1dd2..0000000000 --- a/docs/types/classes/_type_signature_.sr25519signature.md +++ /dev/null @@ -1,852 +0,0 @@ - - -*__name__*: Sr25519Signature - -*__description__*: The default Sr25519 signature that is used accross the system. It is currectly defined as a 512-bit value, represented by a [H512](_primitive_h512_.h512.md). - -# Hierarchy - -↳ [Signature](_type_signature_.signature.md) - -**↳ Sr25519Signature** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[index: `number`\]: `number` -# Constructors - - - -## constructor - -⊕ **new Sr25519Signature**(value?: *[AnyU8a](../modules/_types_.md#anyu8a)*): [Sr25519Signature](_type_signature_.sr25519signature.md) - -*Inherited from [H512](_primitive_h512_.h512.md).[constructor](_primitive_h512_.h512.md#constructor)* - -*Overrides [U8aFixed](_codec_u8afixed_.u8afixed.md).[constructor](_codec_u8afixed_.u8afixed.md#constructor)* - -*Defined in [primitive/H512.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/H512.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyU8a](../modules/_types_.md#anyu8a) | - -**Returns:** [Sr25519Signature](_type_signature_.sr25519signature.md) - -___ - -# Properties - - - -## BYTES_PER_ELEMENT - -**● BYTES_PER_ELEMENT**: *`number`* - -*Inherited from Uint8Array.BYTES_PER_ELEMENT* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1962* - -The size in bytes of each element in the array. - -___ - - -## __@toStringTag - -**● __@toStringTag**: *"UInt8Array"* - -*Inherited from Uint8Array.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:276* - -___ - - -## buffer - -**● buffer**: *`ArrayBufferLike`* - -*Inherited from Uint8Array.buffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1967* - -The ArrayBuffer instance referenced by the array. - -___ - - -## byteLength - -**● byteLength**: *`number`* - -*Inherited from Uint8Array.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1972* - -The length in bytes of the array. - -___ - - -## byteOffset - -**● byteOffset**: *`number`* - -*Inherited from Uint8Array.byteOffset* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1977* - -The offset in bytes of the array. - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[encodedLength](_codec_u8a_.u8a.md#encodedlength)* - -*Defined in [codec/U8a.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L36)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[isEmpty](_codec_u8a_.u8a.md#isempty)* - -*Defined in [codec/U8a.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L43)* - -*__description__*: Returns true if the type wraps an empty/default all-0 value - -**Returns:** `boolean` - -___ - - -## length - -**get length**(): `number` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[length](_codec_u8a_.u8a.md#length)* - -*Overrides Uint8Array.length* - -*Defined in [codec/U8a.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L50)* - -*__description__*: The length of the value - -**Returns:** `number` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:267* - -**Returns:** `IterableIterator`<`number`> - -___ - - -## bitLength - -▸ **bitLength**(): `number` - -*Inherited from [U8aFixed](_codec_u8afixed_.u8afixed.md).[bitLength](_codec_u8afixed_.u8afixed.md#bitlength)* - -*Defined in [codec/U8aFixed.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8aFixed.ts#L52)* - -*__description__*: Returns the number of bits in the value - -**Returns:** `number` - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1988* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, `number`]> - -*Inherited from Uint8Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:271* - -Returns an array of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, `number`]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[eq](_codec_u8a_.u8a.md#eq)* - -*Defined in [codec/U8a.ts:58](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L58)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1998* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *`number`*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Uint8Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2008* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | `number` | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.filter* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2017* - -Returns the elements of an array that meet the condition specified in a callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## find - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): `number` \| `undefined` - -*Inherited from Uint8Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2028* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Uint8Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2039* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Uint8Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2048* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Uint8Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:54* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2056* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Uint8Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2063* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:275* - -Returns an list of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *`number`*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Uint8Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2071* - -Returns the index of the last occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | `number` | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**(callbackfn: *`function`*, thisArg?: *`any`*): `Uint8Array` - -*Inherited from Uint8Array.map* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2086* - -Calls a defined callback function on each element of an array, and returns an array that contains the results. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `Uint8Array` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): `number` - -▸ **reduce**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2098* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2099* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2111* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): `number` - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *`number`*): `number` - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2123* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2124* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | `number` | - -**Returns:** `number` - -*Inherited from Uint8Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2136* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): `Uint8Array` - -*Inherited from Uint8Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2141* - -Reverses the elements in an Array. - -**Returns:** `Uint8Array` - -___ - - -## set - -▸ **set**(array: *`ArrayLike`<`number`>*, offset?: *`undefined` \| `number`*): `void` - -*Inherited from Uint8Array.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2148* - -Sets a value or an array of values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| array | `ArrayLike`<`number`> | A typed or untyped array of values to set. | -| `Optional` offset | `undefined` \| `number` | The index in the current array at which the values are to be written. | - -**Returns:** `void` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from Uint8Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2155* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** `Uint8Array` - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Uint8Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2165* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Uint8Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2172* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## subarray - -▸ **subarray**(begin: *`number`*, end?: *`undefined` \| `number`*): `Uint8Array` - -*Inherited from [U8a](_codec_u8a_.u8a.md).[subarray](_codec_u8a_.u8a.md#subarray)* - -*Overrides Uint8Array.subarray* - -*Defined in [codec/U8a.ts:73](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L73)* - -*__description__*: Create a new subarray from the actual buffer. This is needed for compat reasons since a new Uint8Array gets returned here - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| begin | `number` | The position to start at | -| `Optional` end | `undefined` \| `number` | The position to end at | - -**Returns:** `Uint8Array` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toHex](_codec_u8a_.u8a.md#tohex)* - -*Defined in [codec/U8a.ts:80](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L80)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toJSON](_codec_u8a_.u8a.md#tojson)* - -*Defined in [codec/U8a.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L87)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Uint8Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:2185* - -Converts a number to a string by using the current locale. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toString](_codec_u8a_.u8a.md#tostring)* - -*Overrides Uint8Array.toString* - -*Defined in [codec/U8a.ts:94](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L94)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [U8a](_codec_u8a_.u8a.md).[toU8a](_codec_u8a_.u8a.md#tou8a)* - -*Defined in [codec/U8a.ts:102](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/U8a.ts#L102)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<`number`> - -*Inherited from Uint8Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:279* - -Returns an list of values in the array - -**Returns:** `IterableIterator`<`number`> - -___ - diff --git a/docs/types/classes/_type_signaturepayload_.signaturepayload.html b/docs/types/classes/_type_signaturepayload_.signaturepayload.html deleted file mode 100644 index fdb496ef29..0000000000 --- a/docs/types/classes/_type_signaturepayload_.signaturepayload.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: SignaturePayload

description: A signing payload for an Extrinsic. For the final encoding, it is variable length based on the conetnts included

8 bytes: The Transaction Index/Nonce as provided in the transaction itself. 2+ bytes: The Function Descriptor as provided in the transaction itself. 2 bytes: The Transaction Era as provided in the transaction itself. 32 bytes: The hash of the authoring block implied by the Transaction Era and the current block.

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ SignaturePayload

Implements

Constructors

constructor

⊕ new SignaturePayload(value?: SignaturePayloadValue | Uint8Array): SignaturePayload

Overrides Struct.constructor

Defined in type/SignaturePayload.ts:36

Parameters:

Name Type
Optional value SignaturePayloadValue | Uint8Array

Returns: SignaturePayload

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

blockHash

get blockHash(): Hash

Defined in type/SignaturePayload.ts:57

description: The block Hash the signature applies to (mortal/immortal)

Returns: Hash

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

era

get era(): ExtrinsicEra

Defined in type/SignaturePayload.ts:71

description: The ExtrinsicEra

Returns: ExtrinsicEra

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

isSigned

get isSigned(): boolean

Defined in type/SignaturePayload.ts:50

description: true if the payload refers to a valid signature

Returns: boolean

method

get method(): Method

Defined in type/SignaturePayload.ts:64

description: The Method contained in the payload

Returns: Method

nonce

get nonce(): Nonce

Defined in type/SignaturePayload.ts:78

description: The Nonce

Returns: Nonce

signature

get signature(): Uint8Array

Defined in type/SignaturePayload.ts:85

description: The raw signature as a Uint8Array

Returns: Uint8Array

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

sign

▸ sign(signerPair: KeyringPair, version?: RuntimeVersion): Uint8Array

Defined in type/SignaturePayload.ts:96

description: Sign the payload with the keypair

Parameters:

Name Type
signerPair KeyringPair
Optional version RuntimeVersion

Returns: Uint8Array

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_signaturepayload_.signaturepayload.md b/docs/types/classes/_type_signaturepayload_.signaturepayload.md deleted file mode 100644 index f805056f29..0000000000 --- a/docs/types/classes/_type_signaturepayload_.signaturepayload.md +++ /dev/null @@ -1,548 +0,0 @@ - - -*__name__*: SignaturePayload - -*__description__*: A signing payload for an [Extrinsic](_type_extrinsic_.extrinsic.md). For the final encoding, it is variable length based on the conetnts included - -8 bytes: The Transaction Index/Nonce as provided in the transaction itself. 2+ bytes: The Function Descriptor as provided in the transaction itself. 2 bytes: The Transaction Era as provided in the transaction itself. 32 bytes: The hash of the authoring block implied by the Transaction Era and the current block. - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ SignaturePayload** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new SignaturePayload**(value?: *`SignaturePayloadValue` \| `Uint8Array`*): [SignaturePayload](_type_signaturepayload_.signaturepayload.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/SignaturePayload.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L36)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `SignaturePayloadValue` \| `Uint8Array` | - -**Returns:** [SignaturePayload](_type_signaturepayload_.signaturepayload.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## blockHash - -**get blockHash**(): [Hash](_type_hash_.hash.md) - -*Defined in [type/SignaturePayload.ts:57](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L57)* - -*__description__*: The block [Hash](_type_hash_.hash.md) the signature applies to (mortal/immortal) - -**Returns:** [Hash](_type_hash_.hash.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## era - -**get era**(): [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -*Defined in [type/SignaturePayload.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L71)* - -*__description__*: The [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -**Returns:** [ExtrinsicEra](_type_extrinsicera_.extrinsicera.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## isSigned - -**get isSigned**(): `boolean` - -*Defined in [type/SignaturePayload.ts:50](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L50)* - -*__description__*: `true` if the payload refers to a valid signature - -**Returns:** `boolean` - -___ - - -## method - -**get method**(): [Method](_primitive_method_.method.md) - -*Defined in [type/SignaturePayload.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L64)* - -*__description__*: The [Method](_primitive_method_.method.md) contained in the payload - -**Returns:** [Method](_primitive_method_.method.md) - -___ - - -## nonce - -**get nonce**(): [Nonce](_type_nonce_.nonce.md) - -*Defined in [type/SignaturePayload.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L78)* - -*__description__*: The [Nonce](_type_nonce_.nonce.md) - -**Returns:** [Nonce](_type_nonce_.nonce.md) - -___ - - -## signature - -**get signature**(): `Uint8Array` - -*Defined in [type/SignaturePayload.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L85)* - -*__description__*: The raw signature as a `Uint8Array` - -**Returns:** `Uint8Array` - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## sign - -▸ **sign**(signerPair: *`KeyringPair`*, version?: *[RuntimeVersion](_rpc_runtimeversion_.runtimeversion.md)*): `Uint8Array` - -*Defined in [type/SignaturePayload.ts:96](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/SignaturePayload.ts#L96)* - -*__description__*: Sign the payload with the keypair - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| signerPair | `KeyringPair` | -| `Optional` version | [RuntimeVersion](_rpc_runtimeversion_.runtimeversion.md) | - -**Returns:** `Uint8Array` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_storedpendingchange_.nextauthority.html b/docs/types/classes/_type_storedpendingchange_.nextauthority.html deleted file mode 100644 index 260d564cf2..0000000000 --- a/docs/types/classes/_type_storedpendingchange_.nextauthority.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: NextAuthority

description: The next authority available as SessionKey

Hierarchy

↳ Tuple

↳ NextAuthority

Implements

Indexable

[n: number]: Codec

Constructors

constructor

⊕ new NextAuthority(value?: Uint8Array | NextAuthorityValue): NextAuthority

Overrides Tuple.constructor

Defined in type/StoredPendingChange.ts:30

Parameters:

Name Type
Optional value Uint8Array | NextAuthorityValue

Returns: NextAuthority

Properties

length

● length: number

Inherited from Array.length

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Accessors

Types

get Types(): Array<string>

Inherited from Tuple.Types

Defined in codec/Tuple.ts:75

description: The types definition of the tuple

Returns: Array<string>

encodedLength

get encodedLength(): number

Inherited from Tuple.encodedLength

Defined in codec/Tuple.ts:59

description: The length of the value when encoded as a Uint8Array

Returns: number

index

get index(): U64

Defined in type/StoredPendingChange.ts:38

Returns: U64

isEmpty

get isEmpty(): boolean

Inherited from Tuple.isEmpty

Defined in codec/Tuple.ts:68

description: Checks if the value is an empty value

Returns: boolean

sessionKey

get sessionKey(): SessionKey

Defined in type/StoredPendingChange.ts:42

Returns: SessionKey

Methods

__@iterator

▸ __@iterator(): IterableIterator<Codec>

Inherited from Array.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52

Iterator

Returns: IterableIterator<Codec>

__@unscopables

▸ __@unscopables(): object

Inherited from Array.[Symbol.unscopables]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94

Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns: object

concat

▸ concat(...items: ConcatArray<Codec>[]): Codec[]

▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231

Combines two or more arrays.

Parameters:

Name Type Description
Rest items ConcatArray<Codec>[] Additional items to add to the end of array1.

Returns: Codec[]

Inherited from Array.concat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236

Combines two or more arrays.

Parameters:

Name Type Description
Rest items (T | ConcatArray<T>)[] Additional items to add to the end of array1.

Returns: Codec[]

copyWithin

▸ copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters:

Name Type Description
target number If target is negative, it is treated as length+target where length is the length of the array.
start number If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end undefined | number If not specified, length of the this object is used as its default value.

Returns: this

entries

▸ entries(): IterableIterator<[number, Codec]>

Inherited from Array.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57

Returns an iterable of key, value pairs for every entry in the array

Returns: IterableIterator<[number, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Tuple.eq

Defined in codec/Tuple.ts:84

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

every

▸ every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296

Determines whether all the members of an array satisfy the specified test.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

fill

▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53

Returns the this object after filling the section identified by start and end with value

Parameters:

Name Type Description
value Codec value to fill array section with
Optional start undefined | number index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional end undefined | number index to stop filling the array at. If end is negative, it is treated as length+end.

Returns: this

filter

▸ filter(callbackfn: function, thisArg?: any): Array<Codec>

Inherited from Tuple.filter

Overrides Array.filter

Defined in codec/Tuple.ts:140

description: Filters the array with the callback

Parameters:

Name Type Description
callbackfn function The filter function
Optional thisArg any The `this` object to apply the result to

Returns: Array<Codec>

find

▸ find<S>(predicate: function, thisArg?: any): S | undefined

▸ find(predicate: function, thisArg?: any): Codec | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters:

S : Codec

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: S | undefined

Inherited from Array.find

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32

Parameters:

Name Type
predicate function
Optional thisArg any

Returns: Codec | undefined

findIndex

▸ findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters:

Name Type Description
predicate function find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional thisArg any If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns: number

flat

▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]

▸ flat<U>(this: U[][][][][][][], depth: 6): U[]

▸ flat<U>(this: U[][][][][][], depth: 5): U[]

▸ flat<U>(this: U[][][][][], depth: 4): U[]

▸ flat<U>(this: U[][][][], depth: 3): U[]

▸ flat<U>(this: U[][][], depth: 2): U[]

▸ flat<U>(this: U[][], depth?: undefined | 1): U[]

▸ flat<U>(this: U[], depth: 0): U[]

▸ flat<U>(depth?: undefined | number): any[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][][]
depth 7 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][][]
depth 6 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][][]
depth 5 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][][]
depth 4 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][][]
depth 3 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][][]
depth 2 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[][]
Optional depth undefined | 1 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type parameters:

U

Parameters:

Name Type Description
this U[]
depth 0 The maximum recursion depth

Returns: U[]

Inherited from Array.flat

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.

Type parameters:

U

Parameters:

Name Type Description
Optional depth undefined | number The maximum recursion depth

Returns: any[]

flatMap

▸ flatMap<U,This>(callback: function, thisArg?: This): U[]

Inherited from Array.flatMap

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type parameters:

U

This

Parameters:

Name Type Description
callback function A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.
Optional thisArg This An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns: U[]

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308

Performs the specified action for each element in an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: void

includes

▸ includes(searchElement: Codec, fromIndex?: undefined | number): boolean

Inherited from Array.includes

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters:

Name Type Description
searchElement Codec The element to search for.
Optional fromIndex undefined | number The position in this array at which to begin searching for searchElement.

Returns: boolean

indexOf

▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.indexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284

Returns the index of the first occurrence of a value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns: number

join

▸ join(separator?: undefined | string): string

Inherited from Array.join

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241

Adds all the elements of an array separated by the specified separator string.

Parameters:

Name Type Description
Optional separator undefined | string A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

Returns: string

keys

▸ keys(): IterableIterator<number>

Inherited from Array.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62

Returns an iterable of keys in the array

Returns: IterableIterator<number>

lastIndexOf

▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290

Returns the index of the last occurrence of a specified value in an array.

Parameters:

Name Type Description
searchElement Codec The value to locate in the array.
Optional fromIndex undefined | number The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

Returns: number

map

▸ map<U>(callbackfn: function, thisArg?: any): Array<U>

Inherited from Tuple.map

Overrides Array.map

Defined in codec/Tuple.ts:149

description: Maps the array with the callback

Type parameters:

U

Parameters:

Name Type Description
callbackfn function The mapping function
Optional thisArg any The `this` onject to apply the result to

Returns: Array<U>

pop

▸ pop(): Codec | undefined

Inherited from Array.pop

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221

Removes the last element from an array and returns it.

Returns: Codec | undefined

push

▸ push(...items: Codec[]): number

Inherited from Array.push

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226

Appends new elements to an array, and returns the new length of the array.

Parameters:

Name Type Description
Rest items Codec[] New elements of the Array.

Returns: number

reduce

▸ reduce(callbackfn: function): Codec

▸ reduce(callbackfn: function, initialValue: Codec): Codec

▸ reduce<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduce

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reduceRight

▸ reduceRight(callbackfn: function): Codec

▸ reduceRight(callbackfn: function, initialValue: Codec): Codec

▸ reduceRight<U>(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346

Parameters:

Name Type
callbackfn function
initialValue Codec

Returns: Codec

Inherited from Array.reduceRight

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters:

U

Parameters:

Name Type Description
callbackfn function A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValue U If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns: U

reverse

▸ reverse(): Codec[]

Inherited from Array.reverse

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245

Reverses the elements in an Array.

Returns: Codec[]

shift

▸ shift(): Codec | undefined

Inherited from Array.shift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249

Removes the first element from an array and returns it.

Returns: Codec | undefined

slice

▸ slice(start?: undefined | number, end?: undefined | number): Codec[]

Inherited from Array.slice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255

Returns a section of an array.

Parameters:

Name Type Description
Optional start undefined | number The beginning of the specified portion of the array.
Optional end undefined | number The end of the specified portion of the array.

Returns: Codec[]

some

▸ some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302

Determines whether the specified callback function returns true for any element of an array.

Parameters:

Name Type Description
callbackfn function A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
Optional thisArg any An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns: boolean

sort

▸ sort(compareFn?: undefined | function): this

Inherited from Array.sort

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260

Sorts an array.

Parameters:

Name Type Description
Optional compareFn undefined | function The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

Returns: this

splice

▸ splice(start: number, deleteCount?: undefined | number): Codec[]

▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
Optional deleteCount undefined | number The number of elements to remove.

Returns: Codec[]

Inherited from Array.splice

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters:

Name Type Description
start number The zero-based location in the array from which to start removing elements.
deleteCount number The number of elements to remove.
Rest items Codec[] Elements to insert into the array in place of the deleted elements.

Returns: Codec[]

toArray

▸ toArray(): Array<Codec>

Inherited from Tuple.toArray

Defined in codec/Tuple.ts:91

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Tuple.toHex

Defined in codec/Tuple.ts:98

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Tuple.toJSON

Defined in codec/Tuple.ts:105

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toLocaleString

▸ toLocaleString(): string

Inherited from Array.toLocaleString

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217

Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns: string

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Tuple.toString

Overrides Array.toString

Defined in codec/Tuple.ts:114

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Tuple.toU8a

Defined in codec/Tuple.ts:123

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

unshift

▸ unshift(...items: Codec[]): number

Inherited from Array.unshift

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278

Inserts new elements at the start of an array.

Parameters:

Name Type Description
Rest items Codec[] Elements to insert at the start of the Array.

Returns: number

values

▸ values(): IterableIterator<Codec>

Inherited from Array.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67

Returns an iterable of values in the array

Returns: IterableIterator<Codec>

<Static> with

▸ with(Types: TupleConstructors): Constructor<Tuple>

Inherited from Tuple.with

Defined in codec/Tuple.ts:48

Parameters:

Name Type
Types TupleConstructors

Returns: Constructor<Tuple>

- - - diff --git a/docs/types/classes/_type_storedpendingchange_.nextauthority.md b/docs/types/classes/_type_storedpendingchange_.nextauthority.md deleted file mode 100644 index 5bcc343165..0000000000 --- a/docs/types/classes/_type_storedpendingchange_.nextauthority.md +++ /dev/null @@ -1,1194 +0,0 @@ - - -*__name__*: NextAuthority - -*__description__*: The next authority available as [SessionKey](_type_sessionkey_.sessionkey.md) - -# Hierarchy - -↳ [Tuple](_codec_tuple_.tuple.md) - -**↳ NextAuthority** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Indexable - -\[n: `number`\]: [Codec](../interfaces/_types_.codec.md) -# Constructors - - - -## constructor - -⊕ **new NextAuthority**(value?: *`Uint8Array` \| [NextAuthorityValue](../modules/_type_storedpendingchange_.md#nextauthorityvalue)*): [NextAuthority](_type_storedpendingchange_.nextauthority.md) - -*Overrides [Tuple](_codec_tuple_.tuple.md).[constructor](_codec_tuple_.tuple.md#constructor)* - -*Defined in [type/StoredPendingChange.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L30)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `Uint8Array` \| [NextAuthorityValue](../modules/_type_storedpendingchange_.md#nextauthorityvalue) | - -**Returns:** [NextAuthority](_type_storedpendingchange_.nextauthority.md) - -___ - -# Properties - - - -## length - -**● length**: *`number`* - -*Inherited from Array.length* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209* - -Gets or sets the length of the array. This is a number one higher than the highest element defined in an array. - -___ - -# Accessors - - - -## Types - -**get Types**(): `Array`<`string`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[Types](_codec_tuple_.tuple.md#types)* - -*Defined in [codec/Tuple.ts:75](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L75)* - -*__description__*: The types definition of the tuple - -**Returns:** `Array`<`string`> - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[encodedLength](_codec_tuple_.tuple.md#encodedlength)* - -*Defined in [codec/Tuple.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L59)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## index - -**get index**(): [U64](_primitive_u64_.u64.md) - -*Defined in [type/StoredPendingChange.ts:38](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L38)* - -**Returns:** [U64](_primitive_u64_.u64.md) - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[isEmpty](_codec_tuple_.tuple.md#isempty)* - -*Defined in [codec/Tuple.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L68)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## sessionKey - -**get sessionKey**(): [SessionKey](_type_sessionkey_.sessionkey.md) - -*Defined in [type/StoredPendingChange.ts:42](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L42)* - -**Returns:** [SessionKey](_type_sessionkey_.sessionkey.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52* - -Iterator - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## __@unscopables - -▸ **__@unscopables**(): `object` - -*Inherited from Array.[Symbol.unscopables]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94* - -Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - -**Returns:** `object` - -___ - - -## concat - -▸ **concat**(...items: *`ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[]*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **concat**(...items: *(`T` \| `ConcatArray`<`T`>)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | `ConcatArray`<[Codec](../interfaces/_types_.codec.md)>[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.concat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236* - -Combines two or more arrays. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | (`T` \| `ConcatArray`<`T`>)[] | Additional items to add to the end of array1. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## copyWithin - -▸ **copyWithin**(target: *`number`*, start: *`number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.copyWithin* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64* - -Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| target | `number` | If target is negative, it is treated as length+target where length is the length of the array. | -| start | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | -| `Optional` end | `undefined` \| `number` | If not specified, length of the this object is used as its default value. | - -**Returns:** `this` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Array.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57* - -Returns an iterable of key, value pairs for every entry in the array - -**Returns:** `IterableIterator`<[`number`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[eq](_codec_tuple_.tuple.md#eq)* - -*Defined in [codec/Tuple.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L84)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## every - -▸ **every**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.every* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296* - -Determines whether all the members of an array satisfy the specified test. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## fill - -▸ **fill**(value: *[Codec](../interfaces/_types_.codec.md)*, start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): `this` - -*Inherited from Array.fill* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53* - -Returns the this object after filling the section identified by start and end with value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| value | [Codec](../interfaces/_types_.codec.md) | value to fill array section with | -| `Optional` start | `undefined` \| `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. | -| `Optional` end | `undefined` \| `number` | index to stop filling the array at. If end is negative, it is treated as length+end. | - -**Returns:** `this` - -___ - - -## filter - -▸ **filter**(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[filter](_codec_tuple_.tuple.md#filter)* - -*Overrides Array.filter* - -*Defined in [codec/Tuple.ts:140](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L140)* - -*__description__*: Filters the array with the callback - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The filter function | -| `Optional` thisArg | `any` | The \`this\` object to apply the result to | - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## find - -▸ **find**<`S`>(predicate: *`function`*, thisArg?: *`any`*): `S` \| `undefined` - -▸ **find**(predicate: *`function`*, thisArg?: *`any`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31* - -Returns the value of the first element in the array where predicate is true, and undefined otherwise. - -**Type parameters:** - -#### S : [Codec](../interfaces/_types_.codec.md) -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `S` \| `undefined` - -*Inherited from Array.find* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| predicate | `function` | -| `Optional` thisArg | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## findIndex - -▸ **findIndex**(predicate: *`function`*, thisArg?: *`any`*): `number` - -*Inherited from Array.findIndex* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43* - -Returns the index of the first element in the array where predicate is true, and -1 otherwise. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| predicate | `function` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | -| `Optional` thisArg | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | - -**Returns:** `number` - -___ - - -## flat - -▸ **flat**<`U`>(this: *`U`[][][][][][][][]*, depth: *`7`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][][]*, depth: *`6`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][][]*, depth: *`5`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][][]*, depth: *`4`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][][]*, depth: *`3`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][][]*, depth: *`2`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[][]*, depth?: *`undefined` \| `1`*): `U`[] - -▸ **flat**<`U`>(this: *`U`[]*, depth: *`0`*): `U`[] - -▸ **flat**<`U`>(depth?: *`undefined` \| `number`*): `any`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][][] | -| depth | `7` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][][] | -| depth | `6` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][][] | -| depth | `5` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][][] | -| depth | `4` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][][] | -| depth | `3` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][][] | -| depth | `2` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[][] | -| `Optional` depth | `undefined` \| `1` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| this | `U`[] | -| depth | `0` | The maximum recursion depth | - -**Returns:** `U`[] - -*Inherited from Array.flat* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222* - -Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` depth | `undefined` \| `number` | The maximum recursion depth | - -**Returns:** `any`[] - -___ - - -## flatMap - -▸ **flatMap**<`U`,`This`>(callback: *`function`*, thisArg?: *[This]()*): `U`[] - -*Inherited from Array.flatMap* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147* - -Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - -**Type parameters:** - -#### U -#### This -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callback | `function` | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. | -| `Optional` thisArg | [This]() | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `U`[] - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Array.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308* - -Performs the specified action for each element in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `void` - -___ - - -## includes - -▸ **includes**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `boolean` - -*Inherited from Array.includes* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27* - -Determines whether an array includes a certain element, returning true or false as appropriate. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The element to search for. | -| `Optional` fromIndex | `undefined` \| `number` | The position in this array at which to begin searching for searchElement. | - -**Returns:** `boolean` - -___ - - -## indexOf - -▸ **indexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.indexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284* - -Returns the index of the first occurrence of a value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. | - -**Returns:** `number` - -___ - - -## join - -▸ **join**(separator?: *`undefined` \| `string`*): `string` - -*Inherited from Array.join* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241* - -Adds all the elements of an array separated by the specified separator string. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` separator | `undefined` \| `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | - -**Returns:** `string` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`number`> - -*Inherited from Array.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62* - -Returns an iterable of keys in the array - -**Returns:** `IterableIterator`<`number`> - -___ - - -## lastIndexOf - -▸ **lastIndexOf**(searchElement: *[Codec](../interfaces/_types_.codec.md)*, fromIndex?: *`undefined` \| `number`*): `number` - -*Inherited from Array.lastIndexOf* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290* - -Returns the index of the last occurrence of a specified value in an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| searchElement | [Codec](../interfaces/_types_.codec.md) | The value to locate in the array. | -| `Optional` fromIndex | `undefined` \| `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. | - -**Returns:** `number` - -___ - - -## map - -▸ **map**<`U`>(callbackfn: *`function`*, thisArg?: *`any`*): `Array`<`U`> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[map](_codec_tuple_.tuple.md#map)* - -*Overrides Array.map* - -*Defined in [codec/Tuple.ts:149](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L149)* - -*__description__*: Maps the array with the callback - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | The mapping function | -| `Optional` thisArg | `any` | The \`this\` onject to apply the result to | - -**Returns:** `Array`<`U`> - -___ - - -## pop - -▸ **pop**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.pop* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221* - -Removes the last element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## push - -▸ **push**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.push* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226* - -Appends new elements to an array, and returns the new length of the array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | New elements of the Array. | - -**Returns:** `number` - -___ - - -## reduce - -▸ **reduce**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduce**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduce* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339* - -Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reduceRight - -▸ **reduceRight**(callbackfn: *`function`*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**(callbackfn: *`function`*, initialValue: *[Codec](../interfaces/_types_.codec.md)*): [Codec](../interfaces/_types_.codec.md) - -▸ **reduceRight**<`U`>(callbackfn: *`function`*, initialValue: *`U`*): `U` - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| initialValue | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -*Inherited from Array.reduceRight* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352* - -Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - -**Type parameters:** - -#### U -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | -| initialValue | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | - -**Returns:** `U` - -___ - - -## reverse - -▸ **reverse**(): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.reverse* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245* - -Reverses the elements in an Array. - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## shift - -▸ **shift**(): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from Array.shift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249* - -Removes the first element from an array and returns it. - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## slice - -▸ **slice**(start?: *`undefined` \| `number`*, end?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.slice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255* - -Returns a section of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` start | `undefined` \| `number` | The beginning of the specified portion of the array. | -| `Optional` end | `undefined` \| `number` | The end of the specified portion of the array. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## some - -▸ **some**(callbackfn: *`function`*, thisArg?: *`any`*): `boolean` - -*Inherited from Array.some* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302* - -Determines whether the specified callback function returns true for any element of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| callbackfn | `function` | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. | -| `Optional` thisArg | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | - -**Returns:** `boolean` - -___ - - -## sort - -▸ **sort**(compareFn?: *`undefined` \| `function`*): `this` - -*Inherited from Array.sort* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260* - -Sorts an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` compareFn | `undefined` \| `function` | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. | - -**Returns:** `this` - -___ - - -## splice - -▸ **splice**(start: *`number`*, deleteCount?: *`undefined` \| `number`*): [Codec](../interfaces/_types_.codec.md)[] - -▸ **splice**(start: *`number`*, deleteCount: *`number`*, ...items: *[Codec](../interfaces/_types_.codec.md)[]*): [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| `Optional` deleteCount | `undefined` \| `number` | The number of elements to remove. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -*Inherited from Array.splice* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273* - -Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| start | `number` | The zero-based location in the array from which to start removing elements. | -| deleteCount | `number` | The number of elements to remove. | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert into the array in place of the deleted elements. | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toArray](_codec_tuple_.tuple.md#toarray)* - -*Defined in [codec/Tuple.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L91)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toHex](_codec_tuple_.tuple.md#tohex)* - -*Defined in [codec/Tuple.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L98)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toJSON](_codec_tuple_.tuple.md#tojson)* - -*Defined in [codec/Tuple.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L105)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toLocaleString - -▸ **toLocaleString**(): `string` - -*Inherited from Array.toLocaleString* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217* - -Returns a string representation of an array. The elements are converted to string using their toLocalString methods. - -**Returns:** `string` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toString](_codec_tuple_.tuple.md#tostring)* - -*Overrides Array.toString* - -*Defined in [codec/Tuple.ts:114](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L114)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[toU8a](_codec_tuple_.tuple.md#tou8a)* - -*Defined in [codec/Tuple.ts:123](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L123)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## unshift - -▸ **unshift**(...items: *[Codec](../interfaces/_types_.codec.md)[]*): `number` - -*Inherited from Array.unshift* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278* - -Inserts new elements at the start of an array. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Rest` items | [Codec](../interfaces/_types_.codec.md)[] | Elements to insert at the start of the Array. | - -**Returns:** `number` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Array.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67* - -Returns an iterable of values in the array - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**(Types: *`TupleConstructors`*): [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -*Inherited from [Tuple](_codec_tuple_.tuple.md).[with](_codec_tuple_.tuple.md#with)* - -*Defined in [codec/Tuple.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Tuple.ts#L48)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `TupleConstructors` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Tuple](_codec_tuple_.tuple.md)> - -___ - diff --git a/docs/types/classes/_type_storedpendingchange_.storedpendingchange.html b/docs/types/classes/_type_storedpendingchange_.storedpendingchange.html deleted file mode 100644 index 3a5d3e477d..0000000000 --- a/docs/types/classes/_type_storedpendingchange_.storedpendingchange.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: StoredPendingChange

description: Stored pending change for a Grandpa events

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ StoredPendingChange

Implements

Constructors

constructor

⊕ new StoredPendingChange(value?: Uint8Array | StoredPendingChangeValue): StoredPendingChange

Overrides Struct.constructor

Defined in type/StoredPendingChange.ts:52

Parameters:

Name Type
Optional value Uint8Array | StoredPendingChangeValue

Returns: StoredPendingChange

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

delay

get delay(): BlockNumber

Defined in type/StoredPendingChange.ts:64

Returns: BlockNumber

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

nextAuthorities

get nextAuthorities(): Vector<NextAuthority>

Defined in type/StoredPendingChange.ts:68

Returns: Vector<NextAuthority>

scheduledAt

get scheduledAt(): BlockNumber

Defined in type/StoredPendingChange.ts:72

Returns: BlockNumber

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_storedpendingchange_.storedpendingchange.md b/docs/types/classes/_type_storedpendingchange_.storedpendingchange.md deleted file mode 100644 index 3d262fe8a4..0000000000 --- a/docs/types/classes/_type_storedpendingchange_.storedpendingchange.md +++ /dev/null @@ -1,481 +0,0 @@ - - -*__name__*: StoredPendingChange - -*__description__*: Stored pending change for a Grandpa events - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ StoredPendingChange** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new StoredPendingChange**(value?: *`Uint8Array` \| [StoredPendingChangeValue](../modules/_type_storedpendingchange_.md#storedpendingchangevalue)*): [StoredPendingChange](_type_storedpendingchange_.storedpendingchange.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/StoredPendingChange.ts:52](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L52)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `Uint8Array` \| [StoredPendingChangeValue](../modules/_type_storedpendingchange_.md#storedpendingchangevalue) | - -**Returns:** [StoredPendingChange](_type_storedpendingchange_.storedpendingchange.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## delay - -**get delay**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Defined in [type/StoredPendingChange.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L64)* - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## nextAuthorities - -**get nextAuthorities**(): [Vector](_codec_vector_.vector.md)<[NextAuthority](_type_storedpendingchange_.nextauthority.md)> - -*Defined in [type/StoredPendingChange.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L68)* - -**Returns:** [Vector](_codec_vector_.vector.md)<[NextAuthority](_type_storedpendingchange_.nextauthority.md)> - -___ - - -## scheduledAt - -**get scheduledAt**(): [BlockNumber](_type_blocknumber_.blocknumber.md) - -*Defined in [type/StoredPendingChange.ts:72](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L72)* - -**Returns:** [BlockNumber](_type_blocknumber_.blocknumber.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_validatorprefs_.validatorprefs.html b/docs/types/classes/_type_validatorprefs_.validatorprefs.html deleted file mode 100644 index dfaaa09311..0000000000 --- a/docs/types/classes/_type_validatorprefs_.validatorprefs.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: ValidatorPrefs

description: Validator preferences

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ ValidatorPrefs

Implements

Constructors

constructor

⊕ new ValidatorPrefs(value?: ValidatorPrefsValue | Uint8Array): ValidatorPrefs

Overrides Struct.constructor

Defined in type/ValidatorPrefs.ts:22

Parameters:

Name Type
Optional value ValidatorPrefsValue | Uint8Array

Returns: ValidatorPrefs

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

unstakeThreshold

get unstakeThreshold(): U32

Defined in type/ValidatorPrefs.ts:33

description: The unstake threshold as U32

Returns: U32

validatorPayment

get validatorPayment(): Compact

Defined in type/ValidatorPrefs.ts:40

description: The payment config for the validator as a Compact Balance

Returns: Compact

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_validatorprefs_.validatorprefs.md b/docs/types/classes/_type_validatorprefs_.validatorprefs.md deleted file mode 100644 index 939bad9f58..0000000000 --- a/docs/types/classes/_type_validatorprefs_.validatorprefs.md +++ /dev/null @@ -1,474 +0,0 @@ - - -*__name__*: ValidatorPrefs - -*__description__*: Validator preferences - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ ValidatorPrefs** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new ValidatorPrefs**(value?: *`ValidatorPrefsValue` \| `Uint8Array`*): [ValidatorPrefs](_type_validatorprefs_.validatorprefs.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/ValidatorPrefs.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ValidatorPrefs.ts#L22)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `ValidatorPrefsValue` \| `Uint8Array` | - -**Returns:** [ValidatorPrefs](_type_validatorprefs_.validatorprefs.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## unstakeThreshold - -**get unstakeThreshold**(): [U32](_primitive_u32_.u32.md) - -*Defined in [type/ValidatorPrefs.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ValidatorPrefs.ts#L33)* - -*__description__*: The unstake threshold as [U32](_primitive_u32_.u32.md) - -**Returns:** [U32](_primitive_u32_.u32.md) - -___ - - -## validatorPayment - -**get validatorPayment**(): [Compact](_codec_compact_.compact.md) - -*Defined in [type/ValidatorPrefs.ts:40](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ValidatorPrefs.ts#L40)* - -*__description__*: The payment config for the validator as a [Compact](_codec_compact_.compact.md) [Balance](_type_balance_.balance.md) - -**Returns:** [Compact](_codec_compact_.compact.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_vestingschedule_.vestingschedule.html b/docs/types/classes/_type_vestingschedule_.vestingschedule.html deleted file mode 100644 index d900f355dc..0000000000 --- a/docs/types/classes/_type_vestingschedule_.vestingschedule.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: VestingSchedule

description: Struct to encode the vesting schedule of an individual account

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ VestingSchedule

Implements

Constructors

constructor

⊕ new VestingSchedule(value?: any): VestingSchedule

Overrides Struct.constructor

Defined in type/VestingSchedule.ts:12

Parameters:

Name Type
Optional value any

Returns: VestingSchedule

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

offset

get offset(): Balance

Defined in type/VestingSchedule.ts:23

description: The offset as Balance

Returns: Balance

perBlock

get perBlock(): Balance

Defined in type/VestingSchedule.ts:30

description: The perBlock value as Balance

Returns: Balance

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Name Type
key keyof S

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Name Type
callbackfn function
Optional thisArg any

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

description: Returns a specific names entry in the structure

Parameters:

Name Type Description
name keyof S The name of the entry to retrieve

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:191

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Name Type
index number

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Name Type
key keyof S

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Name Type
key keyof S
value Codec

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Struct.toString

Defined in codec/Struct.ts:226

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>

- - - diff --git a/docs/types/classes/_type_vestingschedule_.vestingschedule.md b/docs/types/classes/_type_vestingschedule_.vestingschedule.md deleted file mode 100644 index 3ddd683a5c..0000000000 --- a/docs/types/classes/_type_vestingschedule_.vestingschedule.md +++ /dev/null @@ -1,474 +0,0 @@ - - -*__name__*: VestingSchedule - -*__description__*: Struct to encode the vesting schedule of an individual account - -# Type parameters -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -#### T : `object` -#### V : `object` -#### E : `object` -# Hierarchy - -↳ [Struct](_codec_struct_.struct.md) - -**↳ VestingSchedule** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new VestingSchedule**(value?: *`any`*): [VestingSchedule](_type_vestingschedule_.vestingschedule.md) - -*Overrides [Struct](_codec_struct_.struct.md).[constructor](_codec_struct_.struct.md#constructor)* - -*Defined in [type/VestingSchedule.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VestingSchedule.ts#L12)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [VestingSchedule](_type_vestingschedule_.vestingschedule.md) - -___ - -# Properties - - - -## __@toStringTag - -**● __@toStringTag**: *`string`* - -*Inherited from Map.[Symbol.toStringTag]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130* - -___ - - -## size - -**● size**: *`number`* - -*Inherited from Map.size* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28* - -___ - -# Accessors - - - -## Type - -**get Type**(): `E` - -*Inherited from [Struct](_codec_struct_.struct.md).[Type](_codec_struct_.struct.md#type)* - -*Defined in [codec/Struct.ts:160](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L160)* - -*__description__*: Returns the Type description to sthe structure - -**Returns:** `E` - -___ - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Struct](_codec_struct_.struct.md).[encodedLength](_codec_struct_.struct.md#encodedlength)* - -*Defined in [codec/Struct.ts:167](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L167)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Struct](_codec_struct_.struct.md).[isEmpty](_codec_struct_.struct.md#isempty)* - -*Defined in [codec/Struct.ts:145](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L145)* - -*__description__*: Checks if the value is an empty value - -**Returns:** `boolean` - -___ - - -## offset - -**get offset**(): [Balance](_type_balance_.balance.md) - -*Defined in [type/VestingSchedule.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VestingSchedule.ts#L23)* - -*__description__*: The offset as [Balance](_type_balance_.balance.md) - -**Returns:** [Balance](_type_balance_.balance.md) - -___ - - -## perBlock - -**get perBlock**(): [Balance](_type_balance_.balance.md) - -*Defined in [type/VestingSchedule.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VestingSchedule.ts#L30)* - -*__description__*: The perBlock value as [Balance](_type_balance_.balance.md) - -**Returns:** [Balance](_type_balance_.balance.md) - -___ - -# Methods - - - -## __@iterator - -▸ **__@iterator**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.[Symbol.iterator]* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113* - -Returns an iterable of entries in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## clear - -▸ **clear**(): `void` - -*Inherited from Map.clear* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22* - -**Returns:** `void` - -___ - - -## delete - -▸ **delete**(key: *`keyof S`*): `boolean` - -*Inherited from Map.delete* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## entries - -▸ **entries**(): `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -*Inherited from Map.entries* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118* - -Returns an iterable of key, value pairs for every entry in the map. - -**Returns:** `IterableIterator`<[`keyof S`, [Codec](../interfaces/_types_.codec.md)]> - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Struct](_codec_struct_.struct.md).[eq](_codec_struct_.struct.md#eq)* - -*Defined in [codec/Struct.ts:176](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L176)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## forEach - -▸ **forEach**(callbackfn: *`function`*, thisArg?: *`any`*): `void` - -*Inherited from Map.forEach* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| callbackfn | `function` | -| `Optional` thisArg | `any` | - -**Returns:** `void` - -___ - - -## get - -▸ **get**(name: *`keyof S`*): [Codec](../interfaces/_types_.codec.md) \| `undefined` - -*Inherited from [Struct](_codec_struct_.struct.md).[get](_codec_struct_.struct.md#get)* - -*Overrides Map.get* - -*Defined in [codec/Struct.ts:184](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L184)* - -*__description__*: Returns a specific names entry in the structure - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| name | `keyof S` | The name of the entry to retrieve | - -**Returns:** [Codec](../interfaces/_types_.codec.md) \| `undefined` - -___ - - -## getAtIndex - -▸ **getAtIndex**(index: *`number`*): [Codec](../interfaces/_types_.codec.md) - -*Inherited from [Struct](_codec_struct_.struct.md).[getAtIndex](_codec_struct_.struct.md#getatindex)* - -*Defined in [codec/Struct.ts:191](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L191)* - -*__description__*: Returns the values of a member at a specific index (Rather use get(name) for performance) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| index | `number` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## has - -▸ **has**(key: *`keyof S`*): `boolean` - -*Inherited from Map.has* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | - -**Returns:** `boolean` - -___ - - -## keys - -▸ **keys**(): `IterableIterator`<`keyof S`> - -*Inherited from Map.keys* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123* - -Returns an iterable of keys in the map - -**Returns:** `IterableIterator`<`keyof S`> - -___ - - -## set - -▸ **set**(key: *`keyof S`*, value: *[Codec](../interfaces/_types_.codec.md)*): `this` - -*Inherited from Map.set* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| key | `keyof S` | -| value | [Codec](../interfaces/_types_.codec.md) | - -**Returns:** `this` - -___ - - -## toArray - -▸ **toArray**(): `Array`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from [Struct](_codec_struct_.struct.md).[toArray](_codec_struct_.struct.md#toarray)* - -*Defined in [codec/Struct.ts:198](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L198)* - -*__description__*: Converts the Object to an standard JavaScript Array - -**Returns:** `Array`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toHex](_codec_struct_.struct.md#tohex)* - -*Defined in [codec/Struct.ts:205](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L205)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toJSON](_codec_struct_.struct.md#tojson)* - -*Defined in [codec/Struct.ts:212](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L212)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toString](_codec_struct_.struct.md#tostring)* - -*Defined in [codec/Struct.ts:226](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L226)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Struct](_codec_struct_.struct.md).[toU8a](_codec_struct_.struct.md#tou8a)* - -*Defined in [codec/Struct.ts:234](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L234)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## values - -▸ **values**(): `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -*Inherited from Map.values* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128* - -Returns an iterable of values in the map - -**Returns:** `IterableIterator`<[Codec](../interfaces/_types_.codec.md)> - -___ - - -## `` with - -▸ **with**<`S`>(Types: *`S`*): [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -*Inherited from [Struct](_codec_struct_.struct.md).[with](_codec_struct_.struct.md#with)* - -*Defined in [codec/Struct.ts:125](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Struct.ts#L125)* - -**Type parameters:** - -#### S : [ConstructorDef](../modules/_types_.md#constructordef) -**Parameters:** - -| Name | Type | -| ------ | ------ | -| Types | `S` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md)<[Struct](_codec_struct_.struct.md)<`S`>> - -___ - diff --git a/docs/types/classes/_type_vote_.vote.html b/docs/types/classes/_type_vote_.vote.html deleted file mode 100644 index d87443204b..0000000000 --- a/docs/types/classes/_type_vote_.vote.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Vote

description: A number of lock periods, plus a vote, one way or the other.

Hierarchy

↳ I8

↳ Vote

Implements

Constructors

constructor

⊕ new Vote(value?: any): Vote

Overrides I8.constructor

Defined in type/Vote.ts:14

Parameters:

Name Type
Optional value any

Returns: Vote

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isAye

get isAye(): boolean

Defined in type/Vote.ts:32

description: true is the wrapped value is a positive vote

Returns: boolean

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

isNay

get isNay(): boolean

Defined in type/Vote.ts:39

description: true is the wrapped value is a negative vote

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Int.toHex

Overrides AbstractInt.toHex

Defined in codec/Int.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Int.toU8a

Overrides AbstractInt.toU8a

Defined in codec/Int.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_vote_.vote.md b/docs/types/classes/_type_vote_.vote.md deleted file mode 100644 index 2d338acfe7..0000000000 --- a/docs/types/classes/_type_vote_.vote.md +++ /dev/null @@ -1,2052 +0,0 @@ - - -*__name__*: Vote - -*__description__*: A number of lock periods, plus a vote, one way or the other. - -# Hierarchy - -↳ [I8](_primitive_i8_.i8.md) - -**↳ Vote** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new Vote**(value?: *`any`*): [Vote](_type_vote_.vote.md) - -*Overrides [I8](_primitive_i8_.i8.md).[constructor](_primitive_i8_.i8.md#constructor)* - -*Defined in [type/Vote.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Vote.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | `any` | - -**Returns:** [Vote](_type_vote_.vote.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isAye - -**get isAye**(): `boolean` - -*Defined in [type/Vote.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Vote.ts#L32)* - -*__description__*: true is the wrapped value is a positive vote - -**Returns:** `boolean` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - - -## isNay - -**get isNay**(): `boolean` - -*Defined in [type/Vote.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Vote.ts#L39)* - -*__description__*: true is the wrapped value is a negative vote - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Int](_codec_int_.int.md).[toHex](_codec_int_.int.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/Int.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Int](_codec_int_.int.md).[toU8a](_codec_int_.int.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/Int.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Int.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_voteindex_.voteindex.html b/docs/types/classes/_type_voteindex_.voteindex.html deleted file mode 100644 index f192cd2346..0000000000 --- a/docs/types/classes/_type_voteindex_.voteindex.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: VoteIndex

description: Voting index, implemented as a U32

Hierarchy

↳ U32

↳ VoteIndex

Implements

Constructors

constructor

⊕ new VoteIndex(value?: AnyNumber): VoteIndex

Inherited from U32.constructor

Overrides UInt.constructor

Defined in primitive/U32.ts:14

Parameters:

Name Type
Optional value AnyNumber

Returns: VoteIndex

Accessors

encodedLength

get encodedLength(): number

Inherited from AbstractInt.encodedLength

Defined in codec/AbstractInt.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from AbstractInt.isEmpty

Defined in codec/AbstractInt.ts:71

description: Checks if the value is a zero value (align elsewhere)

Returns: boolean

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240

description: addition

Parameters:

Name Type
b BN

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250

description: addition

Parameters:

Name Type
b number

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371

description: and

Parameters:

Name Type
b BN

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391

description: and (NOTE: andln is going to be replaced with andn in future)

Parameters:

Name Type
b number

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: add 1 << b to the number

Parameters:

Name Type
b number

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from AbstractInt.bitLength

Overrides BN.bitLength

Defined in codec/AbstractInt.ts:78

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65

description: clone number

Returns: BN

cmp

▸ cmp(b: BN): -1 | 0 | 1

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

cmpn

▸ cmpn(b: number): -1 | 0 | 1

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b number

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315

description: divide

Parameters:

Name Type
b BN

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346

description: rounded division

Parameters:

Name Type
b BN

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320

description: divide

Parameters:

Name Type
b number

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters:

Name Type
b BN

Returns: object

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from AbstractInt.eq

Overrides BN.eq

Defined in codec/AbstractInt.ts:85

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205

description: a equals b

Parameters:

Name Type
b number

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215

description: convert from two's complement representation, where width is the bit width

Parameters:

Name Type
width number

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: GCD

Parameters:

Name Type
b BN

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180

description: a greater than b

Parameters:

Name Type
b BN

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190

description: a greater than or equals b

Parameters:

Name Type
b BN

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195

description: a greater than or equals b

Parameters:

Name Type
b number

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185

description: a greater than b

Parameters:

Name Type
b number

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245

description: addition

Parameters:

Name Type
b BN

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255

description: addition

Parameters:

Name Type
b number

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376

description: and

Parameters:

Name Type
b BN

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325

description: divide

Parameters:

Name Type
b number

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285

description: multiply

Parameters:

Name Type
b BN

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295

description: multiply

Parameters:

Name Type
b number

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500

description: inverse a modulo b

Parameters:

Name Type
b BN

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356

description: or

Parameters:

Name Type
b BN

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426

description: shift left

Parameters:

Name Type
b number

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446

description: shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters:

Name Type
b number

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275

description: subtraction

Parameters:

Name Type
b number

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386

description: and

Parameters:

Name Type
b BN

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366

description: or

Parameters:

Name Type
b BN

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436

description: shift left

Parameters:

Name Type
b number

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456

description: shift right

Parameters:

Name Type
b number

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411

description: xor

Parameters:

Name Type
b BN

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401

description: xor

Parameters:

Name Type
b BN

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160

description: a less than b

Parameters:

Name Type
b BN

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170

description: a less than or equals b

Parameters:

Name Type
b BN

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175

description: a less than or equals b

Parameters:

Name Type
b number

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165

description: a less than b

Parameters:

Name Type
b number

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466

description: clear bits with indexes higher or equal to b

Parameters:

Name Type
b number

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330

description: reduct

Parameters:

Name Type
b BN

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Name Type
b number

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280

description: multiply

Parameters:

Name Type
b BN

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290

description: multiply

Parameters:

Name Type
b number

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: not (for the width specified by w)

Parameters:

Name Type
w number

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351

description: or

Parameters:

Name Type
b BN

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310

description: raise a to the power of b

Parameters:

Name Type
b BN

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416

description: set specified bit to 1

Parameters:

Name Type
b number

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421

description: shift left

Parameters:

Name Type
b number

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441

description: shift right

Parameters:

Name Type
b number

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260

description: subtraction

Parameters:

Name Type
b BN

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270

description: subtraction

Parameters:

Name Type
b number

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461

description: test if specified bit is set

Parameters:

Name Type
b number

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85

description: convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90

description: convert to an instance of type, which must behave like an Array

Parameters:

Name Type
ArrayType object
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96

Parameters:

Name Type
ArrayType any[]
Optional endian Endianness
Optional length undefined | number

Returns: any[]

toBn

▸ toBn(): BN

Inherited from AbstractInt.toBn

Defined in codec/AbstractInt.ts:98

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Name Type
Optional endian Endianness
Optional length undefined | number

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Overrides AbstractInt.toHex

Defined in codec/UInt.ts:36

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from AbstractInt.toJSON

Overrides BN.toJSON

Defined in codec/AbstractInt.ts:110

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505

description: Convert number to red

Parameters:

Name Type
reductionContext ReductionContext

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from AbstractInt.toString

Overrides BN.toString

Defined in codec/AbstractInt.ts:121

description: Returns the string representation of the value

Parameters:

Name Type Description
Optional base undefined | number The base to use for the conversion

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210

description: convert to two's complement representation, where width is bit width

Parameters:

Name Type
width number

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Overrides AbstractInt.toU8a

Defined in codec/UInt.ts:48

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381

description: and

Parameters:

Name Type
b BN

Returns: BN

ucmp

▸ ucmp(b: BN): -1 | 0 | 1

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Name Type
b BN

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335

description: reduct

Parameters:

Name Type
b BN

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361

description: or

Parameters:

Name Type
b BN

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431

description: shift left

Parameters:

Name Type
b number

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451

description: shift right

Parameters:

Name Type
b number

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406

description: xor

Parameters:

Name Type
b BN

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396

description: xor

Parameters:

Name Type
b BN

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115

description: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

Returns: number

<Static> decodeAbstracInt

▸ decodeAbstracInt(value: AnyNumber, bitLength: UIntBitLength, isNegative: boolean): string

Inherited from AbstractInt.decodeAbstracInt

Defined in codec/AbstractInt.ts:39

Parameters:

Name Type
value AnyNumber
bitLength UIntBitLength
isNegative boolean

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50

description: returns true if the supplied object is a BN.js instance

Parameters:

Name Type
b any

Returns: boolean

<Static> max

▸ max(left: BN, right: BN): BN

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55

description: returns the maximum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> min

▸ min(left: BN, right: BN): BN

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60

description: returns the minimum of 2 BN instances.

Parameters:

Name Type
left BN
right BN

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45

description: create a reduction context with the Montgomery trick.

Parameters:

Name Type
num BN

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40

description: create a reduction context

Parameters:

Name Type
reductionContext BN | IPrimeName

Returns: ReductionContext

- - - diff --git a/docs/types/classes/_type_voteindex_.voteindex.md b/docs/types/classes/_type_voteindex_.voteindex.md deleted file mode 100644 index c5ad736058..0000000000 --- a/docs/types/classes/_type_voteindex_.voteindex.md +++ /dev/null @@ -1,2028 +0,0 @@ - - -*__name__*: VoteIndex - -*__description__*: Voting index, implemented as a [U32](_primitive_u32_.u32.md) - -# Hierarchy - -↳ [U32](_primitive_u32_.u32.md) - -**↳ VoteIndex** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new VoteIndex**(value?: *[AnyNumber](../modules/_types_.md#anynumber)*): [VoteIndex](_type_voteindex_.voteindex.md) - -*Inherited from [U32](_primitive_u32_.u32.md).[constructor](_primitive_u32_.u32.md#constructor)* - -*Overrides [UInt](_codec_uint_.uint.md).[constructor](_codec_uint_.uint.md#constructor)* - -*Defined in [primitive/U32.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/U32.ts#L14)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` value | [AnyNumber](../modules/_types_.md#anynumber) | - -**Returns:** [VoteIndex](_type_voteindex_.voteindex.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from AbstractInt.encodedLength* - -*Defined in [codec/AbstractInt.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from AbstractInt.isEmpty* - -*Defined in [codec/AbstractInt.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L71)* - -*__description__*: Checks if the value is a zero value (align elsewhere) - -**Returns:** `boolean` - -___ - -# Methods - - - -## abs - -▸ **abs**(): `BN` - -*Inherited from BN.abs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:230* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## add - -▸ **add**(b: *`BN`*): `BN` - -*Inherited from BN.add* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:240* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## addn - -▸ **addn**(b: *`number`*): `BN` - -*Inherited from BN.addn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:250* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## and - -▸ **and**(b: *`BN`*): `BN` - -*Inherited from BN.and* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:371* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## andln - -▸ **andln**(b: *`number`*): `BN` - -*Inherited from BN.andln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:391* - -*__description__*: and (NOTE: `andln` is going to be replaced with `andn` in future) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bincn - -▸ **bincn**(b: *`number`*): `BN` - -*Inherited from BN.bincn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475* - -*__description__*: add `1 << b` to the number - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## bitLength - -▸ **bitLength**(): [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -*Inherited from AbstractInt.bitLength* - -*Overrides BN.bitLength* - -*Defined in [codec/AbstractInt.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L78)* - -*__description__*: Returns the number of bits in the value - -**Returns:** [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) - -___ - - -## byteLength - -▸ **byteLength**(): `number` - -*Inherited from BN.byteLength* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120* - -*__description__*: return number of bytes occupied - -**Returns:** `number` - -___ - - -## clone - -▸ **clone**(): `BN` - -*Inherited from BN.clone* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:65* - -*__description__*: clone number - -**Returns:** `BN` - -___ - - -## cmp - -▸ **cmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:145* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## cmpn - -▸ **cmpn**(b: *`number`*): `-1` \| `0` \| `1` - -*Inherited from BN.cmpn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:155* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## div - -▸ **div**(b: *`BN`*): `BN` - -*Inherited from BN.div* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:315* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divRound - -▸ **divRound**(b: *`BN`*): `BN` - -*Inherited from BN.divRound* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:346* - -*__description__*: rounded division - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## divn - -▸ **divn**(b: *`number`*): `BN` - -*Inherited from BN.divn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:320* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## egcd - -▸ **egcd**(b: *`BN`*): `object` - -*Inherited from BN.egcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495* - -*__description__*: Extended GCD results `({ a: ..., b: ..., gcd: ... })` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `object` - -___ - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from AbstractInt.eq* - -*Overrides BN.eq* - -*Defined in [codec/AbstractInt.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L85)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## eqn - -▸ **eqn**(b: *`number`*): `boolean` - -*Inherited from BN.eqn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:205* - -*__description__*: a equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## fromTwos - -▸ **fromTwos**(width: *`number`*): `BN` - -*Inherited from BN.fromTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:215* - -*__description__*: convert from two's complement representation, where width is the bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## gcd - -▸ **gcd**(b: *`BN`*): `BN` - -*Inherited from BN.gcd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490* - -*__description__*: GCD - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## gt - -▸ **gt**(b: *`BN`*): `boolean` - -*Inherited from BN.gt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:180* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gte - -▸ **gte**(b: *`BN`*): `boolean` - -*Inherited from BN.gte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:190* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## gten - -▸ **gten**(b: *`number`*): `boolean` - -*Inherited from BN.gten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:195* - -*__description__*: a greater than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## gtn - -▸ **gtn**(b: *`number`*): `boolean` - -*Inherited from BN.gtn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:185* - -*__description__*: a greater than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## iabs - -▸ **iabs**(): `BN` - -*Inherited from BN.iabs* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:235* - -*__description__*: absolute value - -**Returns:** `BN` - -___ - - -## iadd - -▸ **iadd**(b: *`BN`*): `BN` - -*Inherited from BN.iadd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:245* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iaddn - -▸ **iaddn**(b: *`number`*): `BN` - -*Inherited from BN.iaddn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:255* - -*__description__*: addition - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iand - -▸ **iand**(b: *`BN`*): `BN` - -*Inherited from BN.iand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:376* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## idivn - -▸ **idivn**(b: *`number`*): `BN` - -*Inherited from BN.idivn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:325* - -*__description__*: divide - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imaskn - -▸ **imaskn**(b: *`number`*): `BN` - -*Inherited from BN.imaskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:471* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## imul - -▸ **imul**(b: *`BN`*): `BN` - -*Inherited from BN.imul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:285* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## imuln - -▸ **imuln**(b: *`number`*): `BN` - -*Inherited from BN.imuln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:295* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ineg - -▸ **ineg**(): `BN` - -*Inherited from BN.ineg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:225* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## inotn - -▸ **inotn**(w: *`number`*): `BN` - -*Inherited from BN.inotn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## invm - -▸ **invm**(b: *`BN`*): `BN` - -*Inherited from BN.invm* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:500* - -*__description__*: inverse `a` modulo `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ior - -▸ **ior**(b: *`BN`*): `BN` - -*Inherited from BN.ior* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:356* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isEven - -▸ **isEven**(): `boolean` - -*Inherited from BN.isEven* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:130* - -*__description__*: check if value is even - -**Returns:** `boolean` - -___ - - -## isNeg - -▸ **isNeg**(): `boolean` - -*Inherited from BN.isNeg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:125* - -*__description__*: true if the number is negative - -**Returns:** `boolean` - -___ - - -## isOdd - -▸ **isOdd**(): `boolean` - -*Inherited from BN.isOdd* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:135* - -*__description__*: check if value is odd - -**Returns:** `boolean` - -___ - - -## isZero - -▸ **isZero**(): `boolean` - -*Inherited from BN.isZero* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:140* - -*__description__*: check if value is zero - -**Returns:** `boolean` - -___ - - -## ishln - -▸ **ishln**(b: *`number`*): `BN` - -*Inherited from BN.ishln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:426* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ishrn - -▸ **ishrn**(b: *`number`*): `BN` - -*Inherited from BN.ishrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:446* - -*__description__*: shift right (unimplemented [https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086](https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## isqr - -▸ **isqr**(): `BN` - -*Inherited from BN.isqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:305* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## isub - -▸ **isub**(b: *`BN`*): `BN` - -*Inherited from BN.isub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:265* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## isubn - -▸ **isubn**(b: *`number`*): `BN` - -*Inherited from BN.isubn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:275* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuand - -▸ **iuand**(b: *`BN`*): `BN` - -*Inherited from BN.iuand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:386* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iuor - -▸ **iuor**(b: *`BN`*): `BN` - -*Inherited from BN.iuor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:366* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## iushln - -▸ **iushln**(b: *`number`*): `BN` - -*Inherited from BN.iushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:436* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iushrn - -▸ **iushrn**(b: *`number`*): `BN` - -*Inherited from BN.iushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:456* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## iuxor - -▸ **iuxor**(b: *`BN`*): `BN` - -*Inherited from BN.iuxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:411* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ixor - -▸ **ixor**(b: *`BN`*): `BN` - -*Inherited from BN.ixor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:401* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## lt - -▸ **lt**(b: *`BN`*): `boolean` - -*Inherited from BN.lt* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:160* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lte - -▸ **lte**(b: *`BN`*): `boolean` - -*Inherited from BN.lte* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:170* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `boolean` - -___ - - -## lten - -▸ **lten**(b: *`number`*): `boolean` - -*Inherited from BN.lten* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:175* - -*__description__*: a less than or equals b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## ltn - -▸ **ltn**(b: *`number`*): `boolean` - -*Inherited from BN.ltn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:165* - -*__description__*: a less than b - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## maskn - -▸ **maskn**(b: *`number`*): `BN` - -*Inherited from BN.maskn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:466* - -*__description__*: clear bits with indexes higher or equal to `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## mod - -▸ **mod**(b: *`BN`*): `BN` - -*Inherited from BN.mod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:330* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## modn - -▸ **modn**(b: *`number`*): `number` - -*Inherited from BN.modn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:341* - -*__see__*: API consistency [https://github.com/indutny/bn.js/pull/130](https://github.com/indutny/bn.js/pull/130) - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `number` - -___ - - -## mul - -▸ **mul**(b: *`BN`*): `BN` - -*Inherited from BN.mul* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:280* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## muln - -▸ **muln**(b: *`number`*): `BN` - -*Inherited from BN.muln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:290* - -*__description__*: multiply - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## neg - -▸ **neg**(): `BN` - -*Inherited from BN.neg* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:220* - -*__description__*: negate sign - -**Returns:** `BN` - -___ - - -## notn - -▸ **notn**(w: *`number`*): `BN` - -*Inherited from BN.notn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480* - -*__description__*: not (for the width specified by `w`) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| w | `number` | - -**Returns:** `BN` - -___ - - -## or - -▸ **or**(b: *`BN`*): `BN` - -*Inherited from BN.or* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:351* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## pow - -▸ **pow**(b: *`BN`*): `BN` - -*Inherited from BN.pow* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:310* - -*__description__*: raise `a` to the power of `b` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## setn - -▸ **setn**(b: *`number`*): `BN` - -*Inherited from BN.setn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:416* - -*__description__*: set specified bit to 1 - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shln - -▸ **shln**(b: *`number`*): `BN` - -*Inherited from BN.shln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:421* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## shrn - -▸ **shrn**(b: *`number`*): `BN` - -*Inherited from BN.shrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:441* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## sqr - -▸ **sqr**(): `BN` - -*Inherited from BN.sqr* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:300* - -*__description__*: square - -**Returns:** `BN` - -___ - - -## sub - -▸ **sub**(b: *`BN`*): `BN` - -*Inherited from BN.sub* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:260* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## subn - -▸ **subn**(b: *`number`*): `BN` - -*Inherited from BN.subn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:270* - -*__description__*: subtraction - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## testn - -▸ **testn**(b: *`number`*): `boolean` - -*Inherited from BN.testn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:461* - -*__description__*: test if specified bit is set - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `boolean` - -___ - - -## toArray - -▸ **toArray**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `number`[] - -*Inherited from BN.toArray* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:85* - -*__description__*: convert to byte Array, and optionally zero pad to length, throwing if already exceeding - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `number`[] - -___ - - -## toArrayLike - -▸ **toArrayLike**(ArrayType: *`object`*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -▸ **toArrayLike**(ArrayType: *`any`[]*, endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `any`[] - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:90* - -*__description__*: convert to an instance of `type`, which must behave like an Array - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `object` | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -*Inherited from BN.toArrayLike* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:96* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| ArrayType | `any`[] | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `any`[] - -___ - - -## toBn - -▸ **toBn**(): `BN` - -*Inherited from AbstractInt.toBn* - -*Defined in [codec/AbstractInt.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L98)* - -*__description__*: Returns the BN representation of the number. (Compatibility) - -**Returns:** `BN` - -___ - - -## toBuffer - -▸ **toBuffer**(endian?: *`Endianness`*, length?: *`undefined` \| `number`*): `Buffer` - -*Inherited from BN.toBuffer* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:105* - -*__description__*: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length) - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` endian | `Endianness` | -| `Optional` length | `undefined` \| `number` | - -**Returns:** `Buffer` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toHex](_codec_uint_.uint.md#tohex)* - -*Overrides AbstractInt.toHex* - -*Defined in [codec/UInt.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L36)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from AbstractInt.toJSON* - -*Overrides BN.toJSON* - -*Defined in [codec/AbstractInt.ts:110](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L110)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from BN.toNumber* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:75* - -*__description__*: convert to Javascript Number (limited to 53 bits) - -**Returns:** `number` - -___ - - -## toRed - -▸ **toRed**(reductionContext: *`ReductionContext`*): `RedBN` - -*Inherited from BN.toRed* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:505* - -*__description__*: Convert number to red - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `ReductionContext` | - -**Returns:** `RedBN` - -___ - - -## toString - -▸ **toString**(base?: *`undefined` \| `number`*): `string` - -*Inherited from AbstractInt.toString* - -*Overrides BN.toString* - -*Defined in [codec/AbstractInt.ts:121](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L121)* - -*__description__*: Returns the string representation of the value - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` base | `undefined` \| `number` | The base to use for the conversion | - -**Returns:** `string` - -___ - - -## toTwos - -▸ **toTwos**(width: *`number`*): `BN` - -*Inherited from BN.toTwos* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:210* - -*__description__*: convert to two's complement representation, where width is bit width - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| width | `number` | - -**Returns:** `BN` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [UInt](_codec_uint_.uint.md).[toU8a](_codec_uint_.uint.md#tou8a)* - -*Overrides AbstractInt.toU8a* - -*Defined in [codec/UInt.ts:48](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/UInt.ts#L48)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## uand - -▸ **uand**(b: *`BN`*): `BN` - -*Inherited from BN.uand* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:381* - -*__description__*: and - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ucmp - -▸ **ucmp**(b: *`BN`*): `-1` \| `0` \| `1` - -*Inherited from BN.ucmp* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:150* - -*__description__*: compare numbers and return `-1 (a < b)`, `0 (a == b)`, or `1 (a > b)` depending on the comparison result - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `-1` \| `0` \| `1` - -___ - - -## umod - -▸ **umod**(b: *`BN`*): `BN` - -*Inherited from BN.umod* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:335* - -*__description__*: reduct - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## uor - -▸ **uor**(b: *`BN`*): `BN` - -*Inherited from BN.uor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:361* - -*__description__*: or - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## ushln - -▸ **ushln**(b: *`number`*): `BN` - -*Inherited from BN.ushln* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:431* - -*__description__*: shift left - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## ushrn - -▸ **ushrn**(b: *`number`*): `BN` - -*Inherited from BN.ushrn* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:451* - -*__description__*: shift right - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `number` | - -**Returns:** `BN` - -___ - - -## uxor - -▸ **uxor**(b: *`BN`*): `BN` - -*Inherited from BN.uxor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:406* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## xor - -▸ **xor**(b: *`BN`*): `BN` - -*Inherited from BN.xor* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:396* - -*__description__*: xor - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `BN` | - -**Returns:** `BN` - -___ - - -## zeroBits - -▸ **zeroBits**(): `number` - -*Inherited from BN.zeroBits* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:115* - -*__description__*: return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits) - -**Returns:** `number` - -___ - - -## `` decodeAbstracInt - -▸ **decodeAbstracInt**(value: *[AnyNumber](../modules/_types_.md#anynumber)*, bitLength: *[UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength)*, isNegative: *`boolean`*): `string` - -*Inherited from AbstractInt.decodeAbstracInt* - -*Defined in [codec/AbstractInt.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L39)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [AnyNumber](../modules/_types_.md#anynumber) | -| bitLength | [UIntBitLength](../modules/_codec_abstractint_.md#uintbitlength) | -| isNegative | `boolean` | - -**Returns:** `string` - -___ - - -## `` isBN - -▸ **isBN**(b: *`any`*): `boolean` - -*Inherited from BN.isBN* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:50* - -*__description__*: returns true if the supplied object is a BN.js instance - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| b | `any` | - -**Returns:** `boolean` - -___ - - -## `` max - -▸ **max**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.max* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:55* - -*__description__*: returns the maximum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` min - -▸ **min**(left: *`BN`*, right: *`BN`*): `BN` - -*Inherited from BN.min* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:60* - -*__description__*: returns the minimum of 2 BN instances. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| left | `BN` | -| right | `BN` | - -**Returns:** `BN` - -___ - - -## `` mont - -▸ **mont**(num: *`BN`*): `ReductionContext` - -*Inherited from BN.mont* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:45* - -*__description__*: create a reduction context with the Montgomery trick. - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| num | `BN` | - -**Returns:** `ReductionContext` - -___ - - -## `` red - -▸ **red**(reductionContext: *`BN` \| `IPrimeName`*): `ReductionContext` - -*Inherited from BN.red* - -*Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:40* - -*__description__*: create a reduction context - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| reductionContext | `BN` \| `IPrimeName` | - -**Returns:** `ReductionContext` - -___ - diff --git a/docs/types/classes/_type_votethreshold_.votethreshold.html b/docs/types/classes/_type_votethreshold_.votethreshold.html deleted file mode 100644 index bf4a083a68..0000000000 --- a/docs/types/classes/_type_votethreshold_.votethreshold.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: VoteThreshold

description: Voting threshold, used inside proposals to set change the voting tally

Hierarchy

↳ Enum

↳ VoteThreshold

Implements

Constructors

constructor

⊕ new VoteThreshold(index?: number | Uint8Array): VoteThreshold

Overrides Enum.constructor

Defined in type/VoteThreshold.ts:12

Parameters:

Name Type
Optional index number | Uint8Array

Returns: VoteThreshold

Accessors

encodedLength

get encodedLength(): number

Inherited from Enum.encodedLength

Defined in codec/Enum.ts:64

description: The length of the value when encoded as a Uint8Array

Returns: number

isEmpty

get isEmpty(): boolean

Inherited from Enum.isEmpty

Defined in codec/Enum.ts:71

description: Checks if the value is an empty value (always false)

Returns: boolean

Methods

eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Enum.eq

Defined in codec/Enum.ts:78

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Enum.toHex

Defined in codec/Enum.ts:91

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Enum.toJSON

Defined in codec/Enum.ts:98

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from Enum.toNumber

Defined in codec/Enum.ts:105

description: Returns the number representation for the value

Returns: number

toString

▸ toString(): string

Implementation of Codec.toString

Inherited from Enum.toString

Defined in codec/Enum.ts:112

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Enum.toU8a

Defined in codec/Enum.ts:120

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

<Static> decodeEnum

▸ decodeEnum(def: EnumDef, value: Enum | Uint8Array | string | number): number | undefined

Inherited from Enum.decodeEnum

Defined in codec/Enum.ts:47

Parameters:

Name Type
def EnumDef
value Enum | Uint8Array | string | number

Returns: number | undefined

- - - diff --git a/docs/types/classes/_type_votethreshold_.votethreshold.md b/docs/types/classes/_type_votethreshold_.votethreshold.md deleted file mode 100644 index fd6c5df029..0000000000 --- a/docs/types/classes/_type_votethreshold_.votethreshold.md +++ /dev/null @@ -1,206 +0,0 @@ - - -*__name__*: VoteThreshold - -*__description__*: Voting threshold, used inside proposals to set change the voting tally - -# Hierarchy - -↳ [Enum](_codec_enum_.enum.md) - -**↳ VoteThreshold** - -# Implements - -* [Codec](../interfaces/_types_.codec.md) - -# Constructors - - - -## constructor - -⊕ **new VoteThreshold**(index?: *`number` \| `Uint8Array`*): [VoteThreshold](_type_votethreshold_.votethreshold.md) - -*Overrides [Enum](_codec_enum_.enum.md).[constructor](_codec_enum_.enum.md#constructor)* - -*Defined in [type/VoteThreshold.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/VoteThreshold.ts#L12)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` index | `number` \| `Uint8Array` | - -**Returns:** [VoteThreshold](_type_votethreshold_.votethreshold.md) - -___ - -# Accessors - - - -## encodedLength - -**get encodedLength**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[encodedLength](_codec_enum_.enum.md#encodedlength)* - -*Defined in [codec/Enum.ts:64](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L64)* - -*__description__*: The length of the value when encoded as a Uint8Array - -**Returns:** `number` - -___ - - -## isEmpty - -**get isEmpty**(): `boolean` - -*Inherited from [Enum](_codec_enum_.enum.md).[isEmpty](_codec_enum_.enum.md#isempty)* - -*Defined in [codec/Enum.ts:71](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L71)* - -*__description__*: Checks if the value is an empty value (always false) - -**Returns:** `boolean` - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[eq](../interfaces/_types_.codec.md#eq)* - -*Inherited from [Enum](_codec_enum_.enum.md).[eq](_codec_enum_.enum.md#eq)* - -*Defined in [codec/Enum.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L78)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toHex](../interfaces/_types_.codec.md#tohex)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toHex](_codec_enum_.enum.md#tohex)* - -*Defined in [codec/Enum.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L91)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toJSON](../interfaces/_types_.codec.md#tojson)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toJSON](_codec_enum_.enum.md#tojson)* - -*Defined in [codec/Enum.ts:98](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L98)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toNumber - -▸ **toNumber**(): `number` - -*Inherited from [Enum](_codec_enum_.enum.md).[toNumber](_codec_enum_.enum.md#tonumber)* - -*Defined in [codec/Enum.ts:105](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L105)* - -*__description__*: Returns the number representation for the value - -**Returns:** `number` - -___ - - -## toString - -▸ **toString**(): `string` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toString](../interfaces/_types_.codec.md#tostring)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toString](_codec_enum_.enum.md#tostring)* - -*Defined in [codec/Enum.ts:112](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L112)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Implementation of [Codec](../interfaces/_types_.codec.md).[toU8a](../interfaces/_types_.codec.md#tou8a)* - -*Inherited from [Enum](_codec_enum_.enum.md).[toU8a](_codec_enum_.enum.md#tou8a)* - -*Defined in [codec/Enum.ts:120](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L120)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - - -## `` decodeEnum - -▸ **decodeEnum**(def: *`EnumDef`*, value: *[Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number`*): `number` \| `undefined` - -*Inherited from [Enum](_codec_enum_.enum.md).[decodeEnum](_codec_enum_.enum.md#decodeenum)* - -*Defined in [codec/Enum.ts:47](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/Enum.ts#L47)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| def | `EnumDef` | -| value | [Enum](_codec_enum_.enum.md) \| `Uint8Array` \| `string` \| `number` | - -**Returns:** `number` \| `undefined` - -___ - diff --git a/docs/types/enums/_codec_createtype_.typedefinfo.html b/docs/types/enums/_codec_createtype_.typedefinfo.html deleted file mode 100644 index 2c3a109d04..0000000000 --- a/docs/types/enums/_codec_createtype_.typedefinfo.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/enums/_codec_createtype_.typedefinfo.md b/docs/types/enums/_codec_createtype_.typedefinfo.md deleted file mode 100644 index af94095b5f..0000000000 --- a/docs/types/enums/_codec_createtype_.typedefinfo.md +++ /dev/null @@ -1,82 +0,0 @@ - - -# Index - -### Enumeration members - -* [Compact](_codec_createtype_.typedefinfo.md#compact) -* [Enum](_codec_createtype_.typedefinfo.md#enum) -* [Option](_codec_createtype_.typedefinfo.md#option) -* [Plain](_codec_createtype_.typedefinfo.md#plain) -* [Struct](_codec_createtype_.typedefinfo.md#struct) -* [Tuple](_codec_createtype_.typedefinfo.md#tuple) -* [Vector](_codec_createtype_.typedefinfo.md#vector) - ---- - -# Enumeration members - - - -## Compact - -**Compact**: - -*Defined in [codec/createType.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L19)* - -___ - - -## Enum - -**Enum**: - -*Defined in [codec/createType.ts:20](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L20)* - -___ - - -## Option - -**Option**: - -*Defined in [codec/createType.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L21)* - -___ - - -## Plain - -**Plain**: - -*Defined in [codec/createType.ts:22](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L22)* - -___ - - -## Struct - -**Struct**: - -*Defined in [codec/createType.ts:23](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L23)* - -___ - - -## Tuple - -**Tuple**: - -*Defined in [codec/createType.ts:24](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L24)* - -___ - - -## Vector - -**Vector**: - -*Defined in [codec/createType.ts:25](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L25)* - -___ - diff --git a/docs/types/index.html b/docs/types/index.html deleted file mode 100644 index 4fe56fbc87..0000000000 --- a/docs/types/index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

@polkadot/types

Implementation of the types and their (de-)serialisation via parity-codec.

Primitive types

There primitive types are available: Bool, Bytes, Data, H160, H256, H512, I8, I16, I32, I64, I128, I256, Method, Moment, Null, StorageData, StorageKey, Text, Type, U8, U16, U32, U64, U128, U256, USize

Substrate types

These types implement specific types that are found as part of the Substrate base: AccountId, AccountIndex, Address, Amount, AssetOf, AttestedCandidate, AuthorityId, Balance, BalanceOf, Block, BlockNumber, CodeHash, Digest, Event, EventRecord, Extrinsic, ExtrinsicEra, ExtrinsicSignature, Gas, Hash, Header, InherentOfflineReport, Justification, KeyValue, MisbehaviorReport, NewAccountOutcome, Nonce, Origin, ParaId, Perbill, Permill, PrefabWasmModule, PropIndex, Proposal, ProposalIndex, ReferendumIndex, ReferendumInfo, Schedule, SeedOf, SessionKey, Signature, SignaturePayload, StoredPendingChange, ValidatorPrefs, VestingSchedule, Vote, VoteIndex, VoteThreshold

Codec types

These are the base types of the codec, typically not used directly, but rather inherited from to create specific types: Base, Compact, Enum, EnumType, Option, Set, Struct, Tuple, U8a, U8aFixed, UInt, Vector

RPC types

These types are not used in the runtime, but rather are used in RPC results: ChainProperties, ExtrinsicStatus, Health, Json, NetworkState, Metadata, PeerInfo, PendingExtrinsics, RuntimeVersion, SignedBlock, StorageChangeSet

Derived types

Some types are extended from the base to provide additional information: HeaderExtended, [[ReferendumInfoExtended]]

- ← - - Contributing - - → -

- - - diff --git a/docs/types/interfaces/_metadata_types_.metadatainterface.html b/docs/types/interfaces/_metadata_types_.metadatainterface.html deleted file mode 100644 index 2c6cfb20ed..0000000000 --- a/docs/types/interfaces/_metadata_types_.metadatainterface.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/interfaces/_metadata_types_.metadatainterface.md b/docs/types/interfaces/_metadata_types_.metadatainterface.md deleted file mode 100644 index 6e27e2e324..0000000000 --- a/docs/types/interfaces/_metadata_types_.metadatainterface.md +++ /dev/null @@ -1,33 +0,0 @@ - - -# Hierarchy - -**MetadataInterface** - -# Implemented by - -* [Metadata](../classes/_metadata_metadata_.metadata.md) -* [MetadataV0](../classes/_metadata_v0_metadata_.metadatav0.md) -* [MetadataV1](../classes/_metadata_v1_metadata_.metadatav1.md) -* [MetadataVersioned](../classes/_metadata_metadataversioned_.metadataversioned.md) - -# Methods - - - -## getUniqTypes - -▸ **getUniqTypes**(throwError: *`boolean`*): `Array`<`string`> - -*Defined in [Metadata/types.ts:6](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/types.ts#L6)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| throwError | `boolean` | - -**Returns:** `Array`<`string`> - -___ - diff --git a/docs/types/interfaces/_primitive_method_.methodfunction.html b/docs/types/interfaces/_primitive_method_.methodfunction.html deleted file mode 100644 index 8ae23483ab..0000000000 --- a/docs/types/interfaces/_primitive_method_.methodfunction.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/interfaces/_primitive_method_.methodfunction.md b/docs/types/interfaces/_primitive_method_.methodfunction.md deleted file mode 100644 index b6de4a87f3..0000000000 --- a/docs/types/interfaces/_primitive_method_.methodfunction.md +++ /dev/null @@ -1,72 +0,0 @@ - - -# Hierarchy - -**MethodFunction** - -# Callable -▸ **__call**(...args: *`any`[]*): [Method](../classes/_primitive_method_.method.md) - -*Defined in [primitive/Method.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L28)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` args | `any`[] | - -**Returns:** [Method](../classes/_primitive_method_.method.md) - -# Properties - - - -## callIndex - -**● callIndex**: *`Uint8Array`* - -*Defined in [primitive/Method.ts:30](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L30)* - -___ - - -## meta - -**● meta**: *[FunctionMetadata](../classes/_metadata_v0_modules_.functionmetadata.md)* - -*Defined in [primitive/Method.ts:31](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L31)* - -___ - - -## method - -**● method**: *`string`* - -*Defined in [primitive/Method.ts:32](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L32)* - -___ - - -## section - -**● section**: *`string`* - -*Defined in [primitive/Method.ts:33](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L33)* - -___ - - -## toJSON - -**● toJSON**: *`function`* - -*Defined in [primitive/Method.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/Method.ts#L34)* - -#### Type declaration -▸(): `any` - -**Returns:** `any` - -___ - diff --git a/docs/types/interfaces/_primitive_method_.methods.html b/docs/types/interfaces/_primitive_method_.methods.html deleted file mode 100644 index cde88f3fae..0000000000 --- a/docs/types/interfaces/_primitive_method_.methods.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/interfaces/_primitive_method_.methods.md b/docs/types/interfaces/_primitive_method_.methods.md deleted file mode 100644 index f6ada9444a..0000000000 --- a/docs/types/interfaces/_primitive_method_.methods.md +++ /dev/null @@ -1,9 +0,0 @@ - - -# Hierarchy - -**Methods** - -# Indexable - -\[key: `string`\]: [MethodFunction](_primitive_method_.methodfunction.md) diff --git a/docs/types/interfaces/_primitive_method_.moduleswithmethods.html b/docs/types/interfaces/_primitive_method_.moduleswithmethods.html deleted file mode 100644 index 9c3fe7f083..0000000000 --- a/docs/types/interfaces/_primitive_method_.moduleswithmethods.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/interfaces/_primitive_method_.moduleswithmethods.md b/docs/types/interfaces/_primitive_method_.moduleswithmethods.md deleted file mode 100644 index 508efabcad..0000000000 --- a/docs/types/interfaces/_primitive_method_.moduleswithmethods.md +++ /dev/null @@ -1,9 +0,0 @@ - - -# Hierarchy - -**ModulesWithMethods** - -# Indexable - -\[key: `string`\]: [Methods](_primitive_method_.methods.md) diff --git a/docs/types/interfaces/_primitive_storagekey_.storagefunction.html b/docs/types/interfaces/_primitive_storagekey_.storagefunction.html deleted file mode 100644 index 42cc174532..0000000000 --- a/docs/types/interfaces/_primitive_storagekey_.storagefunction.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/interfaces/_primitive_storagekey_.storagefunction.md b/docs/types/interfaces/_primitive_storagekey_.storagefunction.md deleted file mode 100644 index a4e69a3d6b..0000000000 --- a/docs/types/interfaces/_primitive_storagekey_.storagefunction.md +++ /dev/null @@ -1,63 +0,0 @@ - - -# Hierarchy - -**StorageFunction** - -# Callable -▸ **__call**(arg?: *`any`*): `Uint8Array` - -*Defined in [primitive/StorageKey.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L12)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` arg | `any` | - -**Returns:** `Uint8Array` - -# Properties - - - -## meta - -**● meta**: *[StorageFunctionMetadata](../classes/_metadata_v0_modules_.storagefunctionmetadata.md)* - -*Defined in [primitive/StorageKey.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L14)* - -___ - - -## method - -**● method**: *`string`* - -*Defined in [primitive/StorageKey.ts:15](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L15)* - -___ - - -## section - -**● section**: *`string`* - -*Defined in [primitive/StorageKey.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L16)* - -___ - - -## toJSON - -**● toJSON**: *`function`* - -*Defined in [primitive/StorageKey.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/primitive/StorageKey.ts#L17)* - -#### Type declaration -▸(): `any` - -**Returns:** `any` - -___ - diff --git a/docs/types/interfaces/_types_.codec.html b/docs/types/interfaces/_types_.codec.html deleted file mode 100644 index d6ef5aae6c..0000000000 --- a/docs/types/interfaces/_types_.codec.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - -
polkadot-js/api

name: Codec

description: The base Codec interface. All types implement the interface provided here. Additionally implementors can add their own specific interfaces and helpres with getters and functions. The Codec Base is however required for operating as an encoding/decoding layer

Hierarchy

Codec

Implemented by

Properties

encodedLength

● encodedLength: number

Defined in types.ts:34

description: The length of the value when encoded as a Uint8Array

isEmpty

● isEmpty: boolean

Defined in types.ts:39

description: Checks if the value is an empty value

Methods

eq

▸ eq(other?: any): boolean

Defined in types.ts:44

description: Compares the value of the input to see if there is a match

Parameters:

Name Type
Optional other any

Returns: boolean

toHex

▸ toHex(): string

Defined in types.ts:49

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Defined in types.ts:54

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toString

▸ toString(): string

Defined in types.ts:59

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Defined in types.ts:65

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Name Type Description
Optional isBare undefined | false | true true when the value has none of the type-specific prefixes (internal)

Returns: Uint8Array

- - - diff --git a/docs/types/interfaces/_types_.codec.md b/docs/types/interfaces/_types_.codec.md deleted file mode 100644 index c4c53a5c22..0000000000 --- a/docs/types/interfaces/_types_.codec.md +++ /dev/null @@ -1,294 +0,0 @@ - - -*__name__*: Codec - -*__description__*: The base Codec interface. All types implement the interface provided here. Additionally implementors can add their own specific interfaces and helpres with getters and functions. The Codec Base is however required for operating as an encoding/decoding layer - -# Hierarchy - -**Codec** - -# Implemented by - -* [AccountId](../classes/_type_accountid_.accountid.md) -* [AccountIdOf](../classes/_type_accountid_.accountidof.md) -* [AccountIndex](../classes/_type_accountindex_.accountindex.md) -* [Address](../classes/_type_address_.address.md) -* [Amount](../classes/_type_amount_.amount.md) -* [ApiId](../classes/_rpc_runtimeversion_.apiid.md) -* [ApplyExtrinsic](../classes/_type_eventrecord_.applyextrinsic.md) -* [AssetOf](../classes/_type_assetof_.assetof.md) -* [AttestedCandidate](../classes/_type_attestedcandidate_.attestedcandidate.md) -* [AuthoritiesChange](../classes/_type_digest_.authoritieschange.md) -* [AuthorityId](../classes/_type_authorityid_.authorityid.md) -* [AvailabilityVote](../classes/_type_attestedcandidate_.availabilityvote.md) -* [Balance](../classes/_type_balance_.balance.md) -* [BalanceOf](../classes/_type_balance_.balanceof.md) -* [BalanceUpload](../classes/_type_attestedcandidate_.balanceupload.md) -* [BftAtReport](../classes/_type_misbehaviorreport_.bftatreport.md) -* [BftAuthoritySignature](../classes/_type_bft_.bftauthoritysignature.md) -* [BftDoubleCommit](../classes/_type_misbehaviorreport_.bftdoublecommit.md) -* [BftDoublePrepare](../classes/_type_misbehaviorreport_.bftdoubleprepare.md) -* [BftDoublePropose](../classes/_type_misbehaviorreport_.bftdoublepropose.md) -* [BftHashSignature](../classes/_type_bft_.bfthashsignature.md) -* [BftProposeOutOfTurn](../classes/_type_misbehaviorreport_.bftproposeoutofturn.md) -* [Block](../classes/_type_block_.block.md) -* [BlockNumber](../classes/_type_blocknumber_.blocknumber.md) -* [Bool](../classes/_primitive_bool_.bool.md) -* [Broadcast](../classes/_rpc_extrinsicstatus_.broadcast.md) -* [Bytes](../classes/_primitive_bytes_.bytes.md) -* [CallMetadata](../classes/_metadata_v0_modules_.callmetadata.md) -* [CandidateReceipt](../classes/_type_attestedcandidate_.candidatereceipt.md) -* [CandidateSignature](../classes/_type_attestedcandidate_.candidatesignature.md) -* [ChainProperties](../classes/_rpc_chainproperties_.chainproperties.md) -* [ChangesTrieRoot](../classes/_type_digest_.changestrieroot.md) -* [CodeHash](../classes/_type_codehash_.codehash.md) -* [Compact](../classes/_codec_compact_.compact.md) -* [Data](../classes/_primitive_data_.data.md) -* [Default](../classes/_metadata_v1_storage_.default.md) -* [Digest](../classes/_type_digest_.digest.md) -* [DigestItem](../classes/_type_digest_.digestitem.md) -* [Dropped](../classes/_rpc_extrinsicstatus_.dropped.md) -* [Ed25519Signature](../classes/_type_signature_.ed25519signature.md) -* [EgressQueueRoot](../classes/_type_attestedcandidate_.egressqueueroot.md) -* [Enum](../classes/_codec_enum_.enum.md) -* [EnumType](../classes/_codec_enumtype_.enumtype.md) -* [Event](../classes/_type_event_.event.md) -* [EventData](../classes/_type_event_.eventdata.md) -* [EventIndex](../classes/_type_event_.eventindex.md) -* [EventMetadata](../classes/_metadata_v0_events_.eventmetadata.md) -* [EventRecord](../classes/_type_eventrecord_.eventrecord.md) -* [ExplicitCandidateSignature](../classes/_type_attestedcandidate_.explicitcandidatesignature.md) -* [Extrinsic](../classes/_type_extrinsic_.extrinsic.md) -* [ExtrinsicEra](../classes/_type_extrinsicera_.extrinsicera.md) -* [ExtrinsicSignature](../classes/_type_extrinsicsignature_.extrinsicsignature.md) -* [ExtrinsicStatus](../classes/_rpc_extrinsicstatus_.extrinsicstatus.md) -* [Extrinsics](../classes/_type_extrinsics_.extrinsics.md) -* [Finalised](../classes/_rpc_extrinsicstatus_.finalised.md) -* [Finalization](../classes/_type_eventrecord_.finalization.md) -* [FunctionArgumentMetadata](../classes/_metadata_v0_modules_.functionargumentmetadata.md) -* [FunctionMetadata](../classes/_metadata_v0_modules_.functionmetadata.md) -* [Future](../classes/_rpc_extrinsicstatus_.future.md) -* [Gas](../classes/_type_gas_.gas.md) -* [H160](../classes/_primitive_h160_.h160.md) -* [H256](../classes/_primitive_h256_.h256.md) -* [H512](../classes/_primitive_h512_.h512.md) -* [Hash](../classes/_type_hash_.hash.md) -* [HeadData](../classes/_type_attestedcandidate_.headdata.md) -* [Header](../classes/_type_header_.header.md) -* [HeaderExtended](../classes/_type_header_.headerextended.md) -* [Health](../classes/_rpc_health_.health.md) -* [I128](../classes/_primitive_i128_.i128.md) -* [I16](../classes/_primitive_i16_.i16.md) -* [I256](../classes/_primitive_i256_.i256.md) -* [I32](../classes/_primitive_i32_.i32.md) -* [I64](../classes/_primitive_i64_.i64.md) -* [I8](../classes/_primitive_i8_.i8.md) -* [ImplicitCandidateSignature](../classes/_type_attestedcandidate_.implicitcandidatesignature.md) -* [InherentOfflineReport](../classes/_type_inherentofflinereport_.inherentofflinereport.md) -* [Int](../classes/_codec_int_.int.md) -* [Invalid](../classes/_rpc_extrinsicstatus_.invalid.md) -* [Json](../classes/_rpc_json_.json.md) -* [Justification](../classes/_type_justification_.justification.md) -* [KeyValue](../classes/_type_keyvalue_.keyvalue.md) -* [KeyValueOption](../classes/_type_keyvalue_.keyvalueoption.md) -* [LocKPeriods](../classes/_type_lockperiods_.lockperiods.md) -* [MagicNumber](../classes/_metadata_magicnumber_.magicnumber.md) -* [MapType](../classes/_metadata_v1_storage_.maptype.md) -* [MapType](../classes/_metadata_v0_modules_.maptype.md) -* [Metadata](../classes/_metadata_metadata_.metadata.md) -* [MetadataCall](../classes/_metadata_v1_calls_.metadatacall.md) -* [MetadataCallArg](../classes/_metadata_v1_calls_.metadatacallarg.md) -* [MetadataEvent](../classes/_metadata_v1_events_.metadataevent.md) -* [MetadataModule](../classes/_metadata_v1_metadata_.metadatamodule.md) -* [MetadataStorage](../classes/_metadata_v1_storage_.metadatastorage.md) -* [MetadataStorageModifier](../classes/_metadata_v1_storage_.metadatastoragemodifier.md) -* [MetadataStorageType](../classes/_metadata_v1_storage_.metadatastoragetype.md) -* [MetadataV0](../classes/_metadata_v0_metadata_.metadatav0.md) -* [MetadataV1](../classes/_metadata_v1_metadata_.metadatav1.md) -* [MetadataVersioned](../classes/_metadata_metadataversioned_.metadataversioned.md) -* [Method](../classes/_primitive_method_.method.md) -* [MethodIndex](../classes/_primitive_method_.methodindex.md) -* [MisbehaviorKind](../classes/_type_misbehaviorreport_.misbehaviorkind.md) -* [MisbehaviorReport](../classes/_type_misbehaviorreport_.misbehaviorreport.md) -* [ModuleMetadata](../classes/_metadata_v0_modules_.modulemetadata.md) -* [Moment](../classes/_primitive_moment_.moment.md) -* [MomentOf](../classes/_primitive_moment_.momentof.md) -* [NetworkState](../classes/_rpc_networkstate_.networkstate.md) -* [NewAccountOutcome](../classes/_type_newaccountoutcome_.newaccountoutcome.md) -* [NextAuthority](../classes/_type_storedpendingchange_.nextauthority.md) -* [Nonce](../classes/_type_nonce_.nonce.md) -* [NonceCompact](../classes/_type_noncecompact_.noncecompact.md) -* [Null](../classes/_primitive_null_.null.md) -* [Option](../classes/_codec_option_.option.md) -* [Optional](../classes/_metadata_v1_storage_.optional.md) -* [Origin](../classes/_type_origin_.origin.md) -* [Other](../classes/_type_digest_.other.md) -* [OuterDispatchCall](../classes/_metadata_v0_calls_.outerdispatchcall.md) -* [OuterDispatchMetadata](../classes/_metadata_v0_calls_.outerdispatchmetadata.md) -* [OuterEventMetadata](../classes/_metadata_v0_events_.outereventmetadata.md) -* [OuterEventMetadataEvent](../classes/_metadata_v0_events_.outereventmetadataevent.md) -* [ParaId](../classes/_type_paraid_.paraid.md) -* [PeerInfo](../classes/_rpc_peerinfo_.peerinfo.md) -* [PendingExtrinsics](../classes/_rpc_pendingextrinsics_.pendingextrinsics.md) -* [Perbill](../classes/_type_perbill_.perbill.md) -* [Permill](../classes/_type_permill_.permill.md) -* [Phase](../classes/_type_eventrecord_.phase.md) -* [PlainType](../classes/_metadata_v1_storage_.plaintype.md) -* [PrefabWasmModule](../classes/_type_prefabwasmmodule_.prefabwasmmodule.md) -* [PropIndex](../classes/_type_propindex_.propindex.md) -* [Proposal](../classes/_type_proposal_.proposal.md) -* [ProposalIndex](../classes/_type_proposalindex_.proposalindex.md) -* [Ready](../classes/_rpc_extrinsicstatus_.ready.md) -* [ReferendumIndex](../classes/_type_referendumindex_.referendumindex.md) -* [ReferendumInfo](../classes/_type_referenduminfo_.referenduminfo.md) -* [RhdJustification](../classes/_type_justification_.rhdjustification.md) -* [RuntimeModuleMetadata](../classes/_metadata_v0_modules_.runtimemodulemetadata.md) -* [RuntimeVersion](../classes/_rpc_runtimeversion_.runtimeversion.md) -* [RuntimeVersionApi](../classes/_rpc_runtimeversion_.runtimeversionapi.md) -* [Schedule](../classes/_type_schedule_.schedule.md) -* [Seal](../classes/_type_digest_.seal.md) -* [SeedOf](../classes/_type_seedof_.seedof.md) -* [SessionKey](../classes/_type_sessionkey_.sessionkey.md) -* [Set](../classes/_codec_set_.set.md) -* [Signature](../classes/_type_signature_.signature.md) -* [SignaturePayload](../classes/_type_signaturepayload_.signaturepayload.md) -* [SignedBlock](../classes/_rpc_signedblock_.signedblock.md) -* [Sr25519Signature](../classes/_type_signature_.sr25519signature.md) -* [StorageChangeSet](../classes/_rpc_storagechangeset_.storagechangeset.md) -* [StorageData](../classes/_primitive_storagedata_.storagedata.md) -* [StorageFunctionMetadata](../classes/_metadata_v0_modules_.storagefunctionmetadata.md) -* [StorageFunctionModifier](../classes/_metadata_v0_modules_.storagefunctionmodifier.md) -* [StorageFunctionType](../classes/_metadata_v0_modules_.storagefunctiontype.md) -* [StorageKey](../classes/_primitive_storagekey_.storagekey.md) -* [StorageMetadata](../classes/_metadata_v0_modules_.storagemetadata.md) -* [StoredPendingChange](../classes/_type_storedpendingchange_.storedpendingchange.md) -* [Struct](../classes/_codec_struct_.struct.md) -* [Text](../classes/_primitive_text_.text.md) -* [Tuple](../classes/_codec_tuple_.tuple.md) -* [Type](../classes/_primitive_type_.type.md) -* [U128](../classes/_primitive_u128_.u128.md) -* [U16](../classes/_primitive_u16_.u16.md) -* [U256](../classes/_primitive_u256_.u256.md) -* [U32](../classes/_primitive_u32_.u32.md) -* [U64](../classes/_primitive_u64_.u64.md) -* [U8](../classes/_primitive_u8_.u8.md) -* [U8a](../classes/_codec_u8a_.u8a.md) -* [U8aFixed](../classes/_codec_u8afixed_.u8afixed.md) -* [UInt](../classes/_codec_uint_.uint.md) -* [USize](../classes/_primitive_usize_.usize.md) -* [Usurped](../classes/_rpc_extrinsicstatus_.usurped.md) -* [ValidatorPrefs](../classes/_type_validatorprefs_.validatorprefs.md) -* [ValidityAttestation](../classes/_type_attestedcandidate_.validityattestation.md) -* [ValidityVote](../classes/_type_attestedcandidate_.validityvote.md) -* [Vector](../classes/_codec_vector_.vector.md) -* [VestingSchedule](../classes/_type_vestingschedule_.vestingschedule.md) -* [Vote](../classes/_type_vote_.vote.md) -* [VoteIndex](../classes/_type_voteindex_.voteindex.md) -* [VoteThreshold](../classes/_type_votethreshold_.votethreshold.md) - -# Properties - - - -## encodedLength - -**● encodedLength**: *`number`* - -*Defined in [types.ts:34](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L34)* - -*__description__*: The length of the value when encoded as a Uint8Array - -___ - - -## isEmpty - -**● isEmpty**: *`boolean`* - -*Defined in [types.ts:39](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L39)* - -*__description__*: Checks if the value is an empty value - -___ - -# Methods - - - -## eq - -▸ **eq**(other?: *`any`*): `boolean` - -*Defined in [types.ts:44](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L44)* - -*__description__*: Compares the value of the input to see if there is a match - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Optional` other | `any` | - -**Returns:** `boolean` - -___ - - -## toHex - -▸ **toHex**(): `string` - -*Defined in [types.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L49)* - -*__description__*: Returns a hex string representation of the value - -**Returns:** `string` - -___ - - -## toJSON - -▸ **toJSON**(): `any` - -*Defined in [types.ts:54](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L54)* - -*__description__*: Converts the Object to JSON, typically used for RPC transfers - -**Returns:** `any` - -___ - - -## toString - -▸ **toString**(): `string` - -*Defined in [types.ts:59](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L59)* - -*__description__*: Returns the string representation of the value - -**Returns:** `string` - -___ - - -## toU8a - -▸ **toU8a**(isBare?: *`undefined` \| `false` \| `true`*): `Uint8Array` - -*Defined in [types.ts:65](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L65)* - -*__description__*: Encodes the value as a Uint8Array as per the parity-codec specifications - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| `Optional` isBare | `undefined` \| `false` \| `true` | true when the value has none of the type-specific prefixes (internal) | - -**Returns:** `Uint8Array` - -___ - diff --git a/docs/types/interfaces/_types_.constructor.html b/docs/types/interfaces/_types_.constructor.html deleted file mode 100644 index 32b72da053..0000000000 --- a/docs/types/interfaces/_types_.constructor.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type parameters | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/interfaces/_types_.constructor.md b/docs/types/interfaces/_types_.constructor.md deleted file mode 100644 index e9cc062b11..0000000000 --- a/docs/types/interfaces/_types_.constructor.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# Type parameters -#### T -# Hierarchy - -**Constructor** - -# Constructors - - - -## constructor - -⊕ **new Constructor**(...value: *`Array`<`any`>*): `T` - -*Defined in [types.ts:70](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L70)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| `Rest` value | `Array`<`any`> | - -**Returns:** `T` - -___ - diff --git a/docs/types/interfaces/_types_.runtimeversioninterface.html b/docs/types/interfaces/_types_.runtimeversioninterface.html deleted file mode 100644 index b905ea6341..0000000000 --- a/docs/types/interfaces/_types_.runtimeversioninterface.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Hierarchy | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/interfaces/_types_.runtimeversioninterface.md b/docs/types/interfaces/_types_.runtimeversioninterface.md deleted file mode 100644 index b15b5758e1..0000000000 --- a/docs/types/interfaces/_types_.runtimeversioninterface.md +++ /dev/null @@ -1,67 +0,0 @@ - - -# Hierarchy - -**RuntimeVersionInterface** - -# Implemented by - -* [RuntimeVersion](../classes/_rpc_runtimeversion_.runtimeversion.md) - -# Properties - - - -## apis - -**● apis**: *`Array`<`any`>* - -*Defined in [types.ts:83](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L83)* - -___ - - -## authoringVersion - -**● authoringVersion**: *`BN`* - -*Defined in [types.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L84)* - -___ - - -## implName - -**● implName**: *`String`* - -*Defined in [types.ts:85](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L85)* - -___ - - -## implVersion - -**● implVersion**: *`BN`* - -*Defined in [types.ts:86](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L86)* - -___ - - -## specName - -**● specName**: *`String`* - -*Defined in [types.ts:87](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L87)* - -___ - - -## specVersion - -**● specVersion**: *`BN`* - -*Defined in [types.ts:88](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L88)* - -___ - diff --git a/docs/types/modules/_classes_.html b/docs/types/modules/_classes_.html deleted file mode 100644 index f0349961f8..0000000000 --- a/docs/types/modules/_classes_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_classes_.md b/docs/types/modules/_classes_.md deleted file mode 100644 index ac9161cf74..0000000000 --- a/docs/types/modules/_classes_.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# Type aliases - - - -## CodecTypes - -**Ƭ CodecTypes**: *`keyof "/home/travis/build/polkadot-js/api/packages/types/src/index.types"`* - -*Defined in [classes.ts:7](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/classes.ts#L7)* - -___ - diff --git a/docs/types/modules/_codec_abstractint_.html b/docs/types/modules/_codec_abstractint_.html deleted file mode 100644 index 992a1f2567..0000000000 --- a/docs/types/modules/_codec_abstractint_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Type aliases | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_abstractint_.md b/docs/types/modules/_codec_abstractint_.md deleted file mode 100644 index 3ac989de75..0000000000 --- a/docs/types/modules/_codec_abstractint_.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# Type aliases - - - -## UIntBitLength - -**Ƭ UIntBitLength**: *`8` \| `16` \| `32` \| `64` \| `128` \| `256`* - -*Defined in [codec/AbstractInt.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L10)* - -___ - -# Variables - - - -## `` DEFAULT_UINT_BITS - -**● DEFAULT_UINT_BITS**: *`64`* = 64 - -*Defined in [codec/AbstractInt.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/AbstractInt.ts#L12)* - -___ - diff --git a/docs/types/modules/_codec_base_.html b/docs/types/modules/_codec_base_.html deleted file mode 100644 index 523481658a..0000000000 --- a/docs/types/modules/_codec_base_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_base_.md b/docs/types/modules/_codec_base_.md deleted file mode 100644 index 1227d21aad..0000000000 --- a/docs/types/modules/_codec_base_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Base](../classes/_codec_base_.base.md) - ---- - diff --git a/docs/types/modules/_codec_compact_.html b/docs/types/modules/_codec_compact_.html deleted file mode 100644 index 69d1f95daf..0000000000 --- a/docs/types/modules/_codec_compact_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_compact_.md b/docs/types/modules/_codec_compact_.md deleted file mode 100644 index f892d0de37..0000000000 --- a/docs/types/modules/_codec_compact_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Compact](../classes/_codec_compact_.compact.md) - ---- - diff --git a/docs/types/modules/_codec_createtype_.html b/docs/types/modules/_codec_createtype_.html deleted file mode 100644 index 223cbd7c5d..0000000000 --- a/docs/types/modules/_codec_createtype_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - -
polkadot-js/api

Index

Enumerations

Type aliases

Functions

Type aliases

TypeDef

Ƭ TypeDef: object

Defined in codec/createType.ts:28

Type declaration

Functions

createClass

▸ createClass(type: Text | string, value?: any): Constructor

Defined in codec/createType.ts:195

Parameters:

Name Type
type Text | string
Optional value any

Returns: Constructor

createType

▸ createType(type: Text | string, value?: any): Codec

Defined in codec/createType.ts:201

Parameters:

Name Type
type Text | string
Optional value any

Returns: Codec

getTypeClass

▸ getTypeClass(value: TypeDef): Constructor

Defined in codec/createType.ts:139

Parameters:

Name Type
value TypeDef

Returns: Constructor

getTypeDef

▸ getTypeDef(_type: Text | string, name?: undefined | string): TypeDef

Defined in codec/createType.ts:84

Parameters:

Name Type
_type Text | string
Optional name undefined | string

Returns: TypeDef

typeSplit

▸ typeSplit(type: string): Array<string>

Defined in codec/createType.ts:36

Parameters:

Name Type
type string

Returns: Array<string>

- - - diff --git a/docs/types/modules/_codec_createtype_.md b/docs/types/modules/_codec_createtype_.md deleted file mode 100644 index f205741a0d..0000000000 --- a/docs/types/modules/_codec_createtype_.md +++ /dev/null @@ -1,127 +0,0 @@ - - -# Index - -### Enumerations - -* [TypeDefInfo](../enums/_codec_createtype_.typedefinfo.md) - -### Type aliases - -* [TypeDef](_codec_createtype_.md#typedef) - -### Functions - -* [createClass](_codec_createtype_.md#createclass) -* [createType](_codec_createtype_.md#createtype) -* [getTypeClass](_codec_createtype_.md#gettypeclass) -* [getTypeDef](_codec_createtype_.md#gettypedef) -* [typeSplit](_codec_createtype_.md#typesplit) - ---- - -# Type aliases - - - -## TypeDef - -**Ƭ TypeDef**: *`object`* - -*Defined in [codec/createType.ts:28](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L28)* - -#### Type declaration - -___ - -# Functions - - - -## createClass - -▸ **createClass**(type: *[Text](../classes/_primitive_text_.text.md) \| `string`*, value?: *`any`*): [Constructor](../interfaces/_types_.constructor.md) - -*Defined in [codec/createType.ts:195](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L195)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | [Text](../classes/_primitive_text_.text.md) \| `string` | -| `Optional` value | `any` | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md) - -___ - - -## createType - -▸ **createType**(type: *[Text](../classes/_primitive_text_.text.md) \| `string`*, value?: *`any`*): [Codec](../interfaces/_types_.codec.md) - -*Defined in [codec/createType.ts:201](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L201)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | [Text](../classes/_primitive_text_.text.md) \| `string` | -| `Optional` value | `any` | - -**Returns:** [Codec](../interfaces/_types_.codec.md) - -___ - - -## getTypeClass - -▸ **getTypeClass**(value: *[TypeDef](_codec_createtype_.md#typedef)*): [Constructor](../interfaces/_types_.constructor.md) - -*Defined in [codec/createType.ts:139](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L139)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| value | [TypeDef](_codec_createtype_.md#typedef) | - -**Returns:** [Constructor](../interfaces/_types_.constructor.md) - -___ - - -## getTypeDef - -▸ **getTypeDef**(_type: *[Text](../classes/_primitive_text_.text.md) \| `string`*, name?: *`undefined` \| `string`*): [TypeDef](_codec_createtype_.md#typedef) - -*Defined in [codec/createType.ts:84](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L84)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| _type | [Text](../classes/_primitive_text_.text.md) \| `string` | -| `Optional` name | `undefined` \| `string` | - -**Returns:** [TypeDef](_codec_createtype_.md#typedef) - -___ - - -## typeSplit - -▸ **typeSplit**(type: *`string`*): `Array`<`string`> - -*Defined in [codec/createType.ts:36](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/createType.ts#L36)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| type | `string` | - -**Returns:** `Array`<`string`> - -___ - diff --git a/docs/types/modules/_codec_enum_.html b/docs/types/modules/_codec_enum_.html deleted file mode 100644 index 3c4bb128a5..0000000000 --- a/docs/types/modules/_codec_enum_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_enum_.md b/docs/types/modules/_codec_enum_.md deleted file mode 100644 index 7774e75382..0000000000 --- a/docs/types/modules/_codec_enum_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Enum](../classes/_codec_enum_.enum.md) - ---- - diff --git a/docs/types/modules/_codec_enumtype_.html b/docs/types/modules/_codec_enumtype_.html deleted file mode 100644 index a8dfc8b07d..0000000000 --- a/docs/types/modules/_codec_enumtype_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_enumtype_.md b/docs/types/modules/_codec_enumtype_.md deleted file mode 100644 index bac2d20e43..0000000000 --- a/docs/types/modules/_codec_enumtype_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [EnumType](../classes/_codec_enumtype_.enumtype.md) - ---- - diff --git a/docs/types/modules/_codec_int_.html b/docs/types/modules/_codec_int_.html deleted file mode 100644 index 637be5aaf9..0000000000 --- a/docs/types/modules/_codec_int_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_int_.md b/docs/types/modules/_codec_int_.md deleted file mode 100644 index 1ef58e9345..0000000000 --- a/docs/types/modules/_codec_int_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Int](../classes/_codec_int_.int.md) - ---- - diff --git a/docs/types/modules/_codec_option_.html b/docs/types/modules/_codec_option_.html deleted file mode 100644 index fbd1228624..0000000000 --- a/docs/types/modules/_codec_option_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_option_.md b/docs/types/modules/_codec_option_.md deleted file mode 100644 index 31e36dbde9..0000000000 --- a/docs/types/modules/_codec_option_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Option](../classes/_codec_option_.option.md) - ---- - diff --git a/docs/types/modules/_codec_set_.html b/docs/types/modules/_codec_set_.html deleted file mode 100644 index 678ebd47e2..0000000000 --- a/docs/types/modules/_codec_set_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_set_.md b/docs/types/modules/_codec_set_.md deleted file mode 100644 index c56d05b0bc..0000000000 --- a/docs/types/modules/_codec_set_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Set](../classes/_codec_set_.set.md) - ---- - diff --git a/docs/types/modules/_codec_struct_.html b/docs/types/modules/_codec_struct_.html deleted file mode 100644 index eeb54ae5c1..0000000000 --- a/docs/types/modules/_codec_struct_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_struct_.md b/docs/types/modules/_codec_struct_.md deleted file mode 100644 index 78b6b53bf6..0000000000 --- a/docs/types/modules/_codec_struct_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Struct](../classes/_codec_struct_.struct.md) - ---- - diff --git a/docs/types/modules/_codec_tuple_.html b/docs/types/modules/_codec_tuple_.html deleted file mode 100644 index 8255d26d82..0000000000 --- a/docs/types/modules/_codec_tuple_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_tuple_.md b/docs/types/modules/_codec_tuple_.md deleted file mode 100644 index 8b6af3e8ee..0000000000 --- a/docs/types/modules/_codec_tuple_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Tuple](../classes/_codec_tuple_.tuple.md) - ---- - diff --git a/docs/types/modules/_codec_typeregistry_.html b/docs/types/modules/_codec_typeregistry_.html deleted file mode 100644 index 8791ded847..0000000000 --- a/docs/types/modules/_codec_typeregistry_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_typeregistry_.md b/docs/types/modules/_codec_typeregistry_.md deleted file mode 100644 index b6d31a54ad..0000000000 --- a/docs/types/modules/_codec_typeregistry_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [TypeRegistry](../classes/_codec_typeregistry_.typeregistry.md) - ---- - diff --git a/docs/types/modules/_codec_u8a_.html b/docs/types/modules/_codec_u8a_.html deleted file mode 100644 index 29ea72f14f..0000000000 --- a/docs/types/modules/_codec_u8a_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_u8a_.md b/docs/types/modules/_codec_u8a_.md deleted file mode 100644 index 6e7b7aa79e..0000000000 --- a/docs/types/modules/_codec_u8a_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U8a](../classes/_codec_u8a_.u8a.md) - ---- - diff --git a/docs/types/modules/_codec_u8afixed_.html b/docs/types/modules/_codec_u8afixed_.html deleted file mode 100644 index c6d8df83c5..0000000000 --- a/docs/types/modules/_codec_u8afixed_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_u8afixed_.md b/docs/types/modules/_codec_u8afixed_.md deleted file mode 100644 index ab51c99319..0000000000 --- a/docs/types/modules/_codec_u8afixed_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U8aFixed](../classes/_codec_u8afixed_.u8afixed.md) - ---- - diff --git a/docs/types/modules/_codec_uint_.html b/docs/types/modules/_codec_uint_.html deleted file mode 100644 index f10e7f2fbe..0000000000 --- a/docs/types/modules/_codec_uint_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_uint_.md b/docs/types/modules/_codec_uint_.md deleted file mode 100644 index 4f01dedb97..0000000000 --- a/docs/types/modules/_codec_uint_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [UInt](../classes/_codec_uint_.uint.md) - ---- - diff --git a/docs/types/modules/_codec_utils_comparearray_.html b/docs/types/modules/_codec_utils_comparearray_.html deleted file mode 100644 index aeb05e8dec..0000000000 --- a/docs/types/modules/_codec_utils_comparearray_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_utils_comparearray_.md b/docs/types/modules/_codec_utils_comparearray_.md deleted file mode 100644 index ca2669fcf8..0000000000 --- a/docs/types/modules/_codec_utils_comparearray_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# Functions - - - -## compareArray - -▸ **compareArray**(a: *`Array`<`any`>*, b?: *`any`*): `boolean` - -*Defined in [codec/utils/compareArray.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/utils/compareArray.ts#L9)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| a | `Array`<`any`> | -| `Optional` b | `any` | - -**Returns:** `boolean` - -___ - diff --git a/docs/types/modules/_codec_utils_comparemap_.html b/docs/types/modules/_codec_utils_comparemap_.html deleted file mode 100644 index 6951685f20..0000000000 --- a/docs/types/modules/_codec_utils_comparemap_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_utils_comparemap_.md b/docs/types/modules/_codec_utils_comparemap_.md deleted file mode 100644 index 1d58017555..0000000000 --- a/docs/types/modules/_codec_utils_comparemap_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# Functions - - - -## compareMap - -▸ **compareMap**(a: *`Map`<`any`, `any`>*, b?: *`any`*): `boolean` - -*Defined in [codec/utils/compareMap.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/utils/compareMap.ts#L9)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| a | `Map`<`any`, `any`> | -| `Optional` b | `any` | - -**Returns:** `boolean` - -___ - diff --git a/docs/types/modules/_codec_utils_decodeu8a_.html b/docs/types/modules/_codec_utils_decodeu8a_.html deleted file mode 100644 index 09f5f60b89..0000000000 --- a/docs/types/modules/_codec_utils_decodeu8a_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_utils_decodeu8a_.md b/docs/types/modules/_codec_utils_decodeu8a_.md deleted file mode 100644 index 8be9c27a5b..0000000000 --- a/docs/types/modules/_codec_utils_decodeu8a_.md +++ /dev/null @@ -1,25 +0,0 @@ - - -# Functions - - - -## decodeU8a - -▸ **decodeU8a**(u8a: *`Uint8Array`*, _types: *[Constructor](../interfaces/_types_.constructor.md)[] \| `object`*): [Codec](../interfaces/_types_.codec.md)[] - -*Defined in [codec/utils/decodeU8a.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/codec/utils/decodeU8a.ts#L14)* - -Given an u8a, and an array of Type constructors, decode the u8a against the types, and return an array of decoded values. - -**Parameters:** - -| Name | Type | Description | -| ------ | ------ | ------ | -| u8a | `Uint8Array` | The u8a to decode. | -| _types | [Constructor](../interfaces/_types_.constructor.md)[] \| `object` | - -**Returns:** [Codec](../interfaces/_types_.codec.md)[] - -___ - diff --git a/docs/types/modules/_codec_vector_.html b/docs/types/modules/_codec_vector_.html deleted file mode 100644 index 8f20e37fef..0000000000 --- a/docs/types/modules/_codec_vector_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_codec_vector_.md b/docs/types/modules/_codec_vector_.md deleted file mode 100644 index 02bb06dd38..0000000000 --- a/docs/types/modules/_codec_vector_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Vector](../classes/_codec_vector_.vector.md) - ---- - diff --git a/docs/types/modules/_index_types_.html b/docs/types/modules/_index_types_.html deleted file mode 100644 index 0861b9a5f9..0000000000 --- a/docs/types/modules/_index_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_index_types_.md b/docs/types/modules/_index_types_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/types/modules/_index_types_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_metadata_magicnumber_.html b/docs/types/modules/_metadata_magicnumber_.html deleted file mode 100644 index ba2c35eb96..0000000000 --- a/docs/types/modules/_metadata_magicnumber_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_magicnumber_.md b/docs/types/modules/_metadata_magicnumber_.md deleted file mode 100644 index 5735a8c327..0000000000 --- a/docs/types/modules/_metadata_magicnumber_.md +++ /dev/null @@ -1,36 +0,0 @@ - - -# Index - -### Classes - -* [MagicNumber](../classes/_metadata_magicnumber_.magicnumber.md) - -### Variables - -* [MAGIC_ERROR](_metadata_magicnumber_.md#magic_error) -* [MAGIC_NUMBER](_metadata_magicnumber_.md#magic_number) - ---- - -# Variables - - - -## `` MAGIC_ERROR - -**● MAGIC_ERROR**: *`-61746`* = -61746 - -*Defined in [Metadata/MagicNumber.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MagicNumber.ts#L9)* - -___ - - -## `` MAGIC_NUMBER - -**● MAGIC_NUMBER**: *[U32](../classes/_primitive_u32_.u32.md)* = new U32(0x6174656d) - -*Defined in [Metadata/MagicNumber.ts:8](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/MagicNumber.ts#L8)* - -___ - diff --git a/docs/types/modules/_metadata_metadata_.html b/docs/types/modules/_metadata_metadata_.html deleted file mode 100644 index f9f6abcc0b..0000000000 --- a/docs/types/modules/_metadata_metadata_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_metadata_.md b/docs/types/modules/_metadata_metadata_.md deleted file mode 100644 index 0b769a1bef..0000000000 --- a/docs/types/modules/_metadata_metadata_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Metadata](../classes/_metadata_metadata_.metadata.md) - ---- - diff --git a/docs/types/modules/_metadata_metadataversioned_.html b/docs/types/modules/_metadata_metadataversioned_.html deleted file mode 100644 index 61763b36c5..0000000000 --- a/docs/types/modules/_metadata_metadataversioned_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_metadataversioned_.md b/docs/types/modules/_metadata_metadataversioned_.md deleted file mode 100644 index 3dec8614e9..0000000000 --- a/docs/types/modules/_metadata_metadataversioned_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [MetadataVersioned](../classes/_metadata_metadataversioned_.metadataversioned.md) - ---- - diff --git a/docs/types/modules/_metadata_static_.html b/docs/types/modules/_metadata_static_.html deleted file mode 100644 index 2962aac858..0000000000 --- a/docs/types/modules/_metadata_static_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_static_.md b/docs/types/modules/_metadata_static_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/types/modules/_metadata_static_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_metadata_types_.html b/docs/types/modules/_metadata_types_.html deleted file mode 100644 index c73c091492..0000000000 --- a/docs/types/modules/_metadata_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_types_.md b/docs/types/modules/_metadata_types_.md deleted file mode 100644 index 8bd574c233..0000000000 --- a/docs/types/modules/_metadata_types_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Interfaces - -* [MetadataInterface](../interfaces/_metadata_types_.metadatainterface.md) - ---- - diff --git a/docs/types/modules/_metadata_util_flattenuniq_.html b/docs/types/modules/_metadata_util_flattenuniq_.html deleted file mode 100644 index f9e1f46c10..0000000000 --- a/docs/types/modules/_metadata_util_flattenuniq_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_util_flattenuniq_.md b/docs/types/modules/_metadata_util_flattenuniq_.md deleted file mode 100644 index 6a0094b250..0000000000 --- a/docs/types/modules/_metadata_util_flattenuniq_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## flattenUniq - -▸ **flattenUniq**(list: *`Array`<`any`>*): `Array`<`any`> - -*Defined in [Metadata/util/flattenUniq.ts:6](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/util/flattenUniq.ts#L6)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| list | `Array`<`any`> | - -**Returns:** `Array`<`any`> - -___ - diff --git a/docs/types/modules/_metadata_util_validatetypes_.html b/docs/types/modules/_metadata_util_validatetypes_.html deleted file mode 100644 index 3f9d08f6b1..0000000000 --- a/docs/types/modules/_metadata_util_validatetypes_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_util_validatetypes_.md b/docs/types/modules/_metadata_util_validatetypes_.md deleted file mode 100644 index a5d3e28ee7..0000000000 --- a/docs/types/modules/_metadata_util_validatetypes_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# Functions - - - -## validateTypes - -▸ **validateTypes**(types: *`Array`<`string`>*, throwError: *`boolean`*): `void` - -*Defined in [Metadata/util/validateTypes.ts:10](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/util/validateTypes.ts#L10)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| types | `Array`<`string`> | -| throwError | `boolean` | - -**Returns:** `void` - -___ - diff --git a/docs/types/modules/_metadata_v0_calls_.html b/docs/types/modules/_metadata_v0_calls_.html deleted file mode 100644 index 27729683ab..0000000000 --- a/docs/types/modules/_metadata_v0_calls_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v0_calls_.md b/docs/types/modules/_metadata_v0_calls_.md deleted file mode 100644 index 52c98302a8..0000000000 --- a/docs/types/modules/_metadata_v0_calls_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Classes - -* [OuterDispatchCall](../classes/_metadata_v0_calls_.outerdispatchcall.md) -* [OuterDispatchMetadata](../classes/_metadata_v0_calls_.outerdispatchmetadata.md) - ---- - diff --git a/docs/types/modules/_metadata_v0_events_.html b/docs/types/modules/_metadata_v0_events_.html deleted file mode 100644 index dfdda2d845..0000000000 --- a/docs/types/modules/_metadata_v0_events_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v0_events_.md b/docs/types/modules/_metadata_v0_events_.md deleted file mode 100644 index fbe70de55e..0000000000 --- a/docs/types/modules/_metadata_v0_events_.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Index - -### Classes - -* [EventMetadata](../classes/_metadata_v0_events_.eventmetadata.md) -* [OuterEventMetadata](../classes/_metadata_v0_events_.outereventmetadata.md) -* [OuterEventMetadataEvent](../classes/_metadata_v0_events_.outereventmetadataevent.md) - ---- - diff --git a/docs/types/modules/_metadata_v0_metadata_.html b/docs/types/modules/_metadata_v0_metadata_.html deleted file mode 100644 index ee9cc727b0..0000000000 --- a/docs/types/modules/_metadata_v0_metadata_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v0_metadata_.md b/docs/types/modules/_metadata_v0_metadata_.md deleted file mode 100644 index 4de34756d6..0000000000 --- a/docs/types/modules/_metadata_v0_metadata_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [MetadataV0](../classes/_metadata_v0_metadata_.metadatav0.md) - ---- - diff --git a/docs/types/modules/_metadata_v0_modules_.html b/docs/types/modules/_metadata_v0_modules_.html deleted file mode 100644 index 22fdb4a30c..0000000000 --- a/docs/types/modules/_metadata_v0_modules_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v0_modules_.md b/docs/types/modules/_metadata_v0_modules_.md deleted file mode 100644 index 07bbd77492..0000000000 --- a/docs/types/modules/_metadata_v0_modules_.md +++ /dev/null @@ -1,19 +0,0 @@ - - -# Index - -### Classes - -* [CallMetadata](../classes/_metadata_v0_modules_.callmetadata.md) -* [FunctionArgumentMetadata](../classes/_metadata_v0_modules_.functionargumentmetadata.md) -* [FunctionMetadata](../classes/_metadata_v0_modules_.functionmetadata.md) -* [MapType](../classes/_metadata_v0_modules_.maptype.md) -* [ModuleMetadata](../classes/_metadata_v0_modules_.modulemetadata.md) -* [RuntimeModuleMetadata](../classes/_metadata_v0_modules_.runtimemodulemetadata.md) -* [StorageFunctionMetadata](../classes/_metadata_v0_modules_.storagefunctionmetadata.md) -* [StorageFunctionModifier](../classes/_metadata_v0_modules_.storagefunctionmodifier.md) -* [StorageFunctionType](../classes/_metadata_v0_modules_.storagefunctiontype.md) -* [StorageMetadata](../classes/_metadata_v0_modules_.storagemetadata.md) - ---- - diff --git a/docs/types/modules/_metadata_v0_static_.html b/docs/types/modules/_metadata_v0_static_.html deleted file mode 100644 index 8604cb67c6..0000000000 --- a/docs/types/modules/_metadata_v0_static_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v0_static_.md b/docs/types/modules/_metadata_v0_static_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/types/modules/_metadata_v0_static_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_metadata_v1_calls_.html b/docs/types/modules/_metadata_v1_calls_.html deleted file mode 100644 index f732dd034e..0000000000 --- a/docs/types/modules/_metadata_v1_calls_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v1_calls_.md b/docs/types/modules/_metadata_v1_calls_.md deleted file mode 100644 index 5569b5483f..0000000000 --- a/docs/types/modules/_metadata_v1_calls_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Classes - -* [MetadataCall](../classes/_metadata_v1_calls_.metadatacall.md) -* [MetadataCallArg](../classes/_metadata_v1_calls_.metadatacallarg.md) - ---- - diff --git a/docs/types/modules/_metadata_v1_events_.html b/docs/types/modules/_metadata_v1_events_.html deleted file mode 100644 index 2452c551d8..0000000000 --- a/docs/types/modules/_metadata_v1_events_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v1_events_.md b/docs/types/modules/_metadata_v1_events_.md deleted file mode 100644 index 67e744c189..0000000000 --- a/docs/types/modules/_metadata_v1_events_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [MetadataEvent](../classes/_metadata_v1_events_.metadataevent.md) - ---- - diff --git a/docs/types/modules/_metadata_v1_metadata_.html b/docs/types/modules/_metadata_v1_metadata_.html deleted file mode 100644 index 3548f154fe..0000000000 --- a/docs/types/modules/_metadata_v1_metadata_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v1_metadata_.md b/docs/types/modules/_metadata_v1_metadata_.md deleted file mode 100644 index d9318ad42c..0000000000 --- a/docs/types/modules/_metadata_v1_metadata_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Classes - -* [MetadataModule](../classes/_metadata_v1_metadata_.metadatamodule.md) -* [MetadataV1](../classes/_metadata_v1_metadata_.metadatav1.md) - ---- - diff --git a/docs/types/modules/_metadata_v1_static_.html b/docs/types/modules/_metadata_v1_static_.html deleted file mode 100644 index a1c54ae138..0000000000 --- a/docs/types/modules/_metadata_v1_static_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v1_static_.md b/docs/types/modules/_metadata_v1_static_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/types/modules/_metadata_v1_static_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_metadata_v1_storage_.html b/docs/types/modules/_metadata_v1_storage_.html deleted file mode 100644 index 33d7bcbe64..0000000000 --- a/docs/types/modules/_metadata_v1_storage_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v1_storage_.md b/docs/types/modules/_metadata_v1_storage_.md deleted file mode 100644 index a26b4bb1b1..0000000000 --- a/docs/types/modules/_metadata_v1_storage_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Index - -### Classes - -* [Default](../classes/_metadata_v1_storage_.default.md) -* [MapType](../classes/_metadata_v1_storage_.maptype.md) -* [MetadataStorage](../classes/_metadata_v1_storage_.metadatastorage.md) -* [MetadataStorageModifier](../classes/_metadata_v1_storage_.metadatastoragemodifier.md) -* [MetadataStorageType](../classes/_metadata_v1_storage_.metadatastoragetype.md) -* [Optional](../classes/_metadata_v1_storage_.optional.md) -* [PlainType](../classes/_metadata_v1_storage_.plaintype.md) - ---- - diff --git a/docs/types/modules/_metadata_v1_tov0_.html b/docs/types/modules/_metadata_v1_tov0_.html deleted file mode 100644 index e4aa13f98b..0000000000 --- a/docs/types/modules/_metadata_v1_tov0_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Functions | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_metadata_v1_tov0_.md b/docs/types/modules/_metadata_v1_tov0_.md deleted file mode 100644 index 7ab86f17e2..0000000000 --- a/docs/types/modules/_metadata_v1_tov0_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# Functions - - - -## toV0 - -▸ **toV0**(v1: *[MetadataV1](../classes/_metadata_v1_metadata_.metadatav1.md)*): [MetadataV0](../classes/_metadata_v0_metadata_.metadatav0.md) - -*Defined in [Metadata/v1/toV0.ts:96](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/Metadata/v1/toV0.ts#L96)* - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| v1 | [MetadataV1](../classes/_metadata_v1_metadata_.metadatav1.md) | - -**Returns:** [MetadataV0](../classes/_metadata_v0_metadata_.metadatav0.md) - -___ - diff --git a/docs/types/modules/_primitive_bool_.html b/docs/types/modules/_primitive_bool_.html deleted file mode 100644 index 6e2b44675d..0000000000 --- a/docs/types/modules/_primitive_bool_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_bool_.md b/docs/types/modules/_primitive_bool_.md deleted file mode 100644 index 2d36594b0d..0000000000 --- a/docs/types/modules/_primitive_bool_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Bool](../classes/_primitive_bool_.bool.md) - ---- - diff --git a/docs/types/modules/_primitive_bytes_.html b/docs/types/modules/_primitive_bytes_.html deleted file mode 100644 index a3c2b0f5fd..0000000000 --- a/docs/types/modules/_primitive_bytes_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_bytes_.md b/docs/types/modules/_primitive_bytes_.md deleted file mode 100644 index b91bb41bb7..0000000000 --- a/docs/types/modules/_primitive_bytes_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Bytes](../classes/_primitive_bytes_.bytes.md) - ---- - diff --git a/docs/types/modules/_primitive_data_.html b/docs/types/modules/_primitive_data_.html deleted file mode 100644 index 0b0fae814c..0000000000 --- a/docs/types/modules/_primitive_data_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_data_.md b/docs/types/modules/_primitive_data_.md deleted file mode 100644 index 191a822dea..0000000000 --- a/docs/types/modules/_primitive_data_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Data](../classes/_primitive_data_.data.md) - ---- - diff --git a/docs/types/modules/_primitive_h160_.html b/docs/types/modules/_primitive_h160_.html deleted file mode 100644 index 21c61d5399..0000000000 --- a/docs/types/modules/_primitive_h160_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_h160_.md b/docs/types/modules/_primitive_h160_.md deleted file mode 100644 index 77e68e1a60..0000000000 --- a/docs/types/modules/_primitive_h160_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [H160](../classes/_primitive_h160_.h160.md) - ---- - diff --git a/docs/types/modules/_primitive_h256_.html b/docs/types/modules/_primitive_h256_.html deleted file mode 100644 index 9e737fcf9e..0000000000 --- a/docs/types/modules/_primitive_h256_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_h256_.md b/docs/types/modules/_primitive_h256_.md deleted file mode 100644 index d2eff6d1f7..0000000000 --- a/docs/types/modules/_primitive_h256_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [H256](../classes/_primitive_h256_.h256.md) - ---- - diff --git a/docs/types/modules/_primitive_h512_.html b/docs/types/modules/_primitive_h512_.html deleted file mode 100644 index 20b7cd54b5..0000000000 --- a/docs/types/modules/_primitive_h512_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_h512_.md b/docs/types/modules/_primitive_h512_.md deleted file mode 100644 index 3bd90e4504..0000000000 --- a/docs/types/modules/_primitive_h512_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [H512](../classes/_primitive_h512_.h512.md) - ---- - diff --git a/docs/types/modules/_primitive_i128_.html b/docs/types/modules/_primitive_i128_.html deleted file mode 100644 index 98e18908f8..0000000000 --- a/docs/types/modules/_primitive_i128_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_i128_.md b/docs/types/modules/_primitive_i128_.md deleted file mode 100644 index f0181c8947..0000000000 --- a/docs/types/modules/_primitive_i128_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [I128](../classes/_primitive_i128_.i128.md) - ---- - diff --git a/docs/types/modules/_primitive_i16_.html b/docs/types/modules/_primitive_i16_.html deleted file mode 100644 index a230918b32..0000000000 --- a/docs/types/modules/_primitive_i16_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_i16_.md b/docs/types/modules/_primitive_i16_.md deleted file mode 100644 index ac4225798a..0000000000 --- a/docs/types/modules/_primitive_i16_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [I16](../classes/_primitive_i16_.i16.md) - ---- - diff --git a/docs/types/modules/_primitive_i256_.html b/docs/types/modules/_primitive_i256_.html deleted file mode 100644 index f8aa09f2d7..0000000000 --- a/docs/types/modules/_primitive_i256_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_i256_.md b/docs/types/modules/_primitive_i256_.md deleted file mode 100644 index c4fc4645fd..0000000000 --- a/docs/types/modules/_primitive_i256_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [I256](../classes/_primitive_i256_.i256.md) - ---- - diff --git a/docs/types/modules/_primitive_i32_.html b/docs/types/modules/_primitive_i32_.html deleted file mode 100644 index 53c4f01aa4..0000000000 --- a/docs/types/modules/_primitive_i32_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_i32_.md b/docs/types/modules/_primitive_i32_.md deleted file mode 100644 index 69c178c053..0000000000 --- a/docs/types/modules/_primitive_i32_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [I32](../classes/_primitive_i32_.i32.md) - ---- - diff --git a/docs/types/modules/_primitive_i64_.html b/docs/types/modules/_primitive_i64_.html deleted file mode 100644 index 049665613b..0000000000 --- a/docs/types/modules/_primitive_i64_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_i64_.md b/docs/types/modules/_primitive_i64_.md deleted file mode 100644 index b81df498ae..0000000000 --- a/docs/types/modules/_primitive_i64_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [I64](../classes/_primitive_i64_.i64.md) - ---- - diff --git a/docs/types/modules/_primitive_i8_.html b/docs/types/modules/_primitive_i8_.html deleted file mode 100644 index 73de8c0f0c..0000000000 --- a/docs/types/modules/_primitive_i8_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_i8_.md b/docs/types/modules/_primitive_i8_.md deleted file mode 100644 index d96246e629..0000000000 --- a/docs/types/modules/_primitive_i8_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [I8](../classes/_primitive_i8_.i8.md) - ---- - diff --git a/docs/types/modules/_primitive_method_.html b/docs/types/modules/_primitive_method_.html deleted file mode 100644 index 42086a9ce0..0000000000 --- a/docs/types/modules/_primitive_method_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_method_.md b/docs/types/modules/_primitive_method_.md deleted file mode 100644 index d0be4f50a2..0000000000 --- a/docs/types/modules/_primitive_method_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# Index - -### Classes - -* [Method](../classes/_primitive_method_.method.md) -* [MethodIndex](../classes/_primitive_method_.methodindex.md) - -### Interfaces - -* [MethodFunction](../interfaces/_primitive_method_.methodfunction.md) -* [Methods](../interfaces/_primitive_method_.methods.md) -* [ModulesWithMethods](../interfaces/_primitive_method_.moduleswithmethods.md) - ---- - diff --git a/docs/types/modules/_primitive_moment_.html b/docs/types/modules/_primitive_moment_.html deleted file mode 100644 index decad7455c..0000000000 --- a/docs/types/modules/_primitive_moment_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_moment_.md b/docs/types/modules/_primitive_moment_.md deleted file mode 100644 index 604f623071..0000000000 --- a/docs/types/modules/_primitive_moment_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Classes - -* [Moment](../classes/_primitive_moment_.moment.md) -* [MomentOf](../classes/_primitive_moment_.momentof.md) - ---- - diff --git a/docs/types/modules/_primitive_null_.html b/docs/types/modules/_primitive_null_.html deleted file mode 100644 index 6e828ba870..0000000000 --- a/docs/types/modules/_primitive_null_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_null_.md b/docs/types/modules/_primitive_null_.md deleted file mode 100644 index 79d67c3a43..0000000000 --- a/docs/types/modules/_primitive_null_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Null](../classes/_primitive_null_.null.md) - ---- - diff --git a/docs/types/modules/_primitive_storagedata_.html b/docs/types/modules/_primitive_storagedata_.html deleted file mode 100644 index 2f8a813584..0000000000 --- a/docs/types/modules/_primitive_storagedata_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_storagedata_.md b/docs/types/modules/_primitive_storagedata_.md deleted file mode 100644 index a096031456..0000000000 --- a/docs/types/modules/_primitive_storagedata_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [StorageData](../classes/_primitive_storagedata_.storagedata.md) - ---- - diff --git a/docs/types/modules/_primitive_storagekey_.html b/docs/types/modules/_primitive_storagekey_.html deleted file mode 100644 index 61deb7a950..0000000000 --- a/docs/types/modules/_primitive_storagekey_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_storagekey_.md b/docs/types/modules/_primitive_storagekey_.md deleted file mode 100644 index 84ed0a1ff4..0000000000 --- a/docs/types/modules/_primitive_storagekey_.md +++ /dev/null @@ -1,14 +0,0 @@ - - -# Index - -### Classes - -* [StorageKey](../classes/_primitive_storagekey_.storagekey.md) - -### Interfaces - -* [StorageFunction](../interfaces/_primitive_storagekey_.storagefunction.md) - ---- - diff --git a/docs/types/modules/_primitive_text_.html b/docs/types/modules/_primitive_text_.html deleted file mode 100644 index 3679c6c6b2..0000000000 --- a/docs/types/modules/_primitive_text_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_text_.md b/docs/types/modules/_primitive_text_.md deleted file mode 100644 index d48af6f3ae..0000000000 --- a/docs/types/modules/_primitive_text_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Text](../classes/_primitive_text_.text.md) - ---- - diff --git a/docs/types/modules/_primitive_type_.html b/docs/types/modules/_primitive_type_.html deleted file mode 100644 index 34a6403fbe..0000000000 --- a/docs/types/modules/_primitive_type_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_type_.md b/docs/types/modules/_primitive_type_.md deleted file mode 100644 index 6f0861f594..0000000000 --- a/docs/types/modules/_primitive_type_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Type](../classes/_primitive_type_.type.md) - ---- - diff --git a/docs/types/modules/_primitive_u128_.html b/docs/types/modules/_primitive_u128_.html deleted file mode 100644 index 92c62022ad..0000000000 --- a/docs/types/modules/_primitive_u128_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_u128_.md b/docs/types/modules/_primitive_u128_.md deleted file mode 100644 index edad23fe19..0000000000 --- a/docs/types/modules/_primitive_u128_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U128](../classes/_primitive_u128_.u128.md) - ---- - diff --git a/docs/types/modules/_primitive_u16_.html b/docs/types/modules/_primitive_u16_.html deleted file mode 100644 index 26f2115e9a..0000000000 --- a/docs/types/modules/_primitive_u16_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_u16_.md b/docs/types/modules/_primitive_u16_.md deleted file mode 100644 index 7189cf1218..0000000000 --- a/docs/types/modules/_primitive_u16_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U16](../classes/_primitive_u16_.u16.md) - ---- - diff --git a/docs/types/modules/_primitive_u256_.html b/docs/types/modules/_primitive_u256_.html deleted file mode 100644 index b15879cdeb..0000000000 --- a/docs/types/modules/_primitive_u256_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_u256_.md b/docs/types/modules/_primitive_u256_.md deleted file mode 100644 index 9fa968727f..0000000000 --- a/docs/types/modules/_primitive_u256_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U256](../classes/_primitive_u256_.u256.md) - ---- - diff --git a/docs/types/modules/_primitive_u32_.html b/docs/types/modules/_primitive_u32_.html deleted file mode 100644 index 89721299e0..0000000000 --- a/docs/types/modules/_primitive_u32_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_u32_.md b/docs/types/modules/_primitive_u32_.md deleted file mode 100644 index b8ace44c7e..0000000000 --- a/docs/types/modules/_primitive_u32_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U32](../classes/_primitive_u32_.u32.md) - ---- - diff --git a/docs/types/modules/_primitive_u64_.html b/docs/types/modules/_primitive_u64_.html deleted file mode 100644 index 028a093052..0000000000 --- a/docs/types/modules/_primitive_u64_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_u64_.md b/docs/types/modules/_primitive_u64_.md deleted file mode 100644 index bd06302180..0000000000 --- a/docs/types/modules/_primitive_u64_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U64](../classes/_primitive_u64_.u64.md) - ---- - diff --git a/docs/types/modules/_primitive_u8_.html b/docs/types/modules/_primitive_u8_.html deleted file mode 100644 index 7cfbc083ac..0000000000 --- a/docs/types/modules/_primitive_u8_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_u8_.md b/docs/types/modules/_primitive_u8_.md deleted file mode 100644 index fbea4cc3ab..0000000000 --- a/docs/types/modules/_primitive_u8_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [U8](../classes/_primitive_u8_.u8.md) - ---- - diff --git a/docs/types/modules/_primitive_usize_.html b/docs/types/modules/_primitive_usize_.html deleted file mode 100644 index b41035ea03..0000000000 --- a/docs/types/modules/_primitive_usize_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_primitive_usize_.md b/docs/types/modules/_primitive_usize_.md deleted file mode 100644 index 69c7f2a7c1..0000000000 --- a/docs/types/modules/_primitive_usize_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [USize](../classes/_primitive_usize_.usize.md) - ---- - diff --git a/docs/types/modules/_rpc_chainproperties_.html b/docs/types/modules/_rpc_chainproperties_.html deleted file mode 100644 index d5aa20f4cd..0000000000 --- a/docs/types/modules/_rpc_chainproperties_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_chainproperties_.md b/docs/types/modules/_rpc_chainproperties_.md deleted file mode 100644 index 907675f99b..0000000000 --- a/docs/types/modules/_rpc_chainproperties_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ChainProperties](../classes/_rpc_chainproperties_.chainproperties.md) - ---- - diff --git a/docs/types/modules/_rpc_extrinsicstatus_.html b/docs/types/modules/_rpc_extrinsicstatus_.html deleted file mode 100644 index e02edea615..0000000000 --- a/docs/types/modules/_rpc_extrinsicstatus_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_extrinsicstatus_.md b/docs/types/modules/_rpc_extrinsicstatus_.md deleted file mode 100644 index b2ee9faeb4..0000000000 --- a/docs/types/modules/_rpc_extrinsicstatus_.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# Index - -### Classes - -* [Broadcast](../classes/_rpc_extrinsicstatus_.broadcast.md) -* [Dropped](../classes/_rpc_extrinsicstatus_.dropped.md) -* [ExtrinsicStatus](../classes/_rpc_extrinsicstatus_.extrinsicstatus.md) -* [Finalised](../classes/_rpc_extrinsicstatus_.finalised.md) -* [Future](../classes/_rpc_extrinsicstatus_.future.md) -* [Invalid](../classes/_rpc_extrinsicstatus_.invalid.md) -* [Ready](../classes/_rpc_extrinsicstatus_.ready.md) -* [Usurped](../classes/_rpc_extrinsicstatus_.usurped.md) - ---- - diff --git a/docs/types/modules/_rpc_health_.html b/docs/types/modules/_rpc_health_.html deleted file mode 100644 index c7c13cc12d..0000000000 --- a/docs/types/modules/_rpc_health_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_health_.md b/docs/types/modules/_rpc_health_.md deleted file mode 100644 index 1d030e758f..0000000000 --- a/docs/types/modules/_rpc_health_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Health](../classes/_rpc_health_.health.md) - ---- - diff --git a/docs/types/modules/_rpc_json_.html b/docs/types/modules/_rpc_json_.html deleted file mode 100644 index b4f15275bb..0000000000 --- a/docs/types/modules/_rpc_json_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_json_.md b/docs/types/modules/_rpc_json_.md deleted file mode 100644 index 6123a8035f..0000000000 --- a/docs/types/modules/_rpc_json_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Json](../classes/_rpc_json_.json.md) - ---- - diff --git a/docs/types/modules/_rpc_networkstate_.html b/docs/types/modules/_rpc_networkstate_.html deleted file mode 100644 index 0594cb5b9f..0000000000 --- a/docs/types/modules/_rpc_networkstate_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_networkstate_.md b/docs/types/modules/_rpc_networkstate_.md deleted file mode 100644 index 2a1eaade5f..0000000000 --- a/docs/types/modules/_rpc_networkstate_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [NetworkState](../classes/_rpc_networkstate_.networkstate.md) - ---- - diff --git a/docs/types/modules/_rpc_peerinfo_.html b/docs/types/modules/_rpc_peerinfo_.html deleted file mode 100644 index ad175a8a03..0000000000 --- a/docs/types/modules/_rpc_peerinfo_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_peerinfo_.md b/docs/types/modules/_rpc_peerinfo_.md deleted file mode 100644 index 169065f821..0000000000 --- a/docs/types/modules/_rpc_peerinfo_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [PeerInfo](../classes/_rpc_peerinfo_.peerinfo.md) - ---- - diff --git a/docs/types/modules/_rpc_pendingextrinsics_.html b/docs/types/modules/_rpc_pendingextrinsics_.html deleted file mode 100644 index 2a6a781c7c..0000000000 --- a/docs/types/modules/_rpc_pendingextrinsics_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_pendingextrinsics_.md b/docs/types/modules/_rpc_pendingextrinsics_.md deleted file mode 100644 index 02a183225a..0000000000 --- a/docs/types/modules/_rpc_pendingextrinsics_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [PendingExtrinsics](../classes/_rpc_pendingextrinsics_.pendingextrinsics.md) - ---- - diff --git a/docs/types/modules/_rpc_runtimeversion_.html b/docs/types/modules/_rpc_runtimeversion_.html deleted file mode 100644 index cda04c606f..0000000000 --- a/docs/types/modules/_rpc_runtimeversion_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_runtimeversion_.md b/docs/types/modules/_rpc_runtimeversion_.md deleted file mode 100644 index fdd95970ee..0000000000 --- a/docs/types/modules/_rpc_runtimeversion_.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Index - -### Classes - -* [ApiId](../classes/_rpc_runtimeversion_.apiid.md) -* [RuntimeVersion](../classes/_rpc_runtimeversion_.runtimeversion.md) -* [RuntimeVersionApi](../classes/_rpc_runtimeversion_.runtimeversionapi.md) - ---- - diff --git a/docs/types/modules/_rpc_signedblock_.html b/docs/types/modules/_rpc_signedblock_.html deleted file mode 100644 index 9886150479..0000000000 --- a/docs/types/modules/_rpc_signedblock_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_signedblock_.md b/docs/types/modules/_rpc_signedblock_.md deleted file mode 100644 index 2a66a9abca..0000000000 --- a/docs/types/modules/_rpc_signedblock_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [SignedBlock](../classes/_rpc_signedblock_.signedblock.md) - ---- - diff --git a/docs/types/modules/_rpc_storagechangeset_.html b/docs/types/modules/_rpc_storagechangeset_.html deleted file mode 100644 index ecbec898d8..0000000000 --- a/docs/types/modules/_rpc_storagechangeset_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_rpc_storagechangeset_.md b/docs/types/modules/_rpc_storagechangeset_.md deleted file mode 100644 index 0639192083..0000000000 --- a/docs/types/modules/_rpc_storagechangeset_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [StorageChangeSet](../classes/_rpc_storagechangeset_.storagechangeset.md) - ---- - diff --git a/docs/types/modules/_scripts_metadatamd_.html b/docs/types/modules/_scripts_metadatamd_.html deleted file mode 100644 index 7a3536d83f..0000000000 --- a/docs/types/modules/_scripts_metadatamd_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_scripts_metadatamd_.md b/docs/types/modules/_scripts_metadatamd_.md deleted file mode 100644 index 139597f9cb..0000000000 --- a/docs/types/modules/_scripts_metadatamd_.md +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/docs/types/modules/_type_accountid_.html b/docs/types/modules/_type_accountid_.html deleted file mode 100644 index 162ade1c84..0000000000 --- a/docs/types/modules/_type_accountid_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_accountid_.md b/docs/types/modules/_type_accountid_.md deleted file mode 100644 index 02a4833919..0000000000 --- a/docs/types/modules/_type_accountid_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Classes - -* [AccountId](../classes/_type_accountid_.accountid.md) -* [AccountIdOf](../classes/_type_accountid_.accountidof.md) - ---- - diff --git a/docs/types/modules/_type_accountindex_.html b/docs/types/modules/_type_accountindex_.html deleted file mode 100644 index e3fa198418..0000000000 --- a/docs/types/modules/_type_accountindex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_accountindex_.md b/docs/types/modules/_type_accountindex_.md deleted file mode 100644 index deee030fd2..0000000000 --- a/docs/types/modules/_type_accountindex_.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# Index - -### Classes - -* [AccountIndex](../classes/_type_accountindex_.accountindex.md) - -### Variables - -* [ENUMSET_SIZE](_type_accountindex_.md#enumset_size) - ---- - -# Variables - - - -## `` ENUMSET_SIZE - -**● ENUMSET_SIZE**: *`BN`* = new BN(64) - -*Defined in [type/AccountIndex.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/AccountIndex.ts#L12)* - -___ - diff --git a/docs/types/modules/_type_address_.html b/docs/types/modules/_type_address_.html deleted file mode 100644 index 324e4f7ddc..0000000000 --- a/docs/types/modules/_type_address_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_address_.md b/docs/types/modules/_type_address_.md deleted file mode 100644 index d37d037113..0000000000 --- a/docs/types/modules/_type_address_.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# Index - -### Classes - -* [Address](../classes/_type_address_.address.md) - -### Variables - -* [ACCOUNT_ID_PREFIX](_type_address_.md#account_id_prefix) - ---- - -# Variables - - - -## `` ACCOUNT_ID_PREFIX - -**● ACCOUNT_ID_PREFIX**: *`Uint8Array`* = new Uint8Array([0xff]) - -*Defined in [type/Address.ts:16](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Address.ts#L16)* - -___ - diff --git a/docs/types/modules/_type_amount_.html b/docs/types/modules/_type_amount_.html deleted file mode 100644 index faaa194cb9..0000000000 --- a/docs/types/modules/_type_amount_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_amount_.md b/docs/types/modules/_type_amount_.md deleted file mode 100644 index a4ce464dfc..0000000000 --- a/docs/types/modules/_type_amount_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Amount](../classes/_type_amount_.amount.md) - ---- - diff --git a/docs/types/modules/_type_assetof_.html b/docs/types/modules/_type_assetof_.html deleted file mode 100644 index d888fbf040..0000000000 --- a/docs/types/modules/_type_assetof_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_assetof_.md b/docs/types/modules/_type_assetof_.md deleted file mode 100644 index aa411a6bfd..0000000000 --- a/docs/types/modules/_type_assetof_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [AssetOf](../classes/_type_assetof_.assetof.md) - ---- - diff --git a/docs/types/modules/_type_attestedcandidate_.html b/docs/types/modules/_type_attestedcandidate_.html deleted file mode 100644 index d0abbc6e39..0000000000 --- a/docs/types/modules/_type_attestedcandidate_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_attestedcandidate_.md b/docs/types/modules/_type_attestedcandidate_.md deleted file mode 100644 index e8532bb7f7..0000000000 --- a/docs/types/modules/_type_attestedcandidate_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# Index - -### Classes - -* [AttestedCandidate](../classes/_type_attestedcandidate_.attestedcandidate.md) -* [AvailabilityVote](../classes/_type_attestedcandidate_.availabilityvote.md) -* [BalanceUpload](../classes/_type_attestedcandidate_.balanceupload.md) -* [CandidateReceipt](../classes/_type_attestedcandidate_.candidatereceipt.md) -* [CandidateSignature](../classes/_type_attestedcandidate_.candidatesignature.md) -* [EgressQueueRoot](../classes/_type_attestedcandidate_.egressqueueroot.md) -* [ExplicitCandidateSignature](../classes/_type_attestedcandidate_.explicitcandidatesignature.md) -* [HeadData](../classes/_type_attestedcandidate_.headdata.md) -* [ImplicitCandidateSignature](../classes/_type_attestedcandidate_.implicitcandidatesignature.md) -* [ValidityAttestation](../classes/_type_attestedcandidate_.validityattestation.md) -* [ValidityVote](../classes/_type_attestedcandidate_.validityvote.md) - ---- - diff --git a/docs/types/modules/_type_authorityid_.html b/docs/types/modules/_type_authorityid_.html deleted file mode 100644 index 601ca037bf..0000000000 --- a/docs/types/modules/_type_authorityid_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_authorityid_.md b/docs/types/modules/_type_authorityid_.md deleted file mode 100644 index 22333495c6..0000000000 --- a/docs/types/modules/_type_authorityid_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [AuthorityId](../classes/_type_authorityid_.authorityid.md) - ---- - diff --git a/docs/types/modules/_type_balance_.html b/docs/types/modules/_type_balance_.html deleted file mode 100644 index d197fc0a62..0000000000 --- a/docs/types/modules/_type_balance_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_balance_.md b/docs/types/modules/_type_balance_.md deleted file mode 100644 index ecce24fa7e..0000000000 --- a/docs/types/modules/_type_balance_.md +++ /dev/null @@ -1,11 +0,0 @@ - - -# Index - -### Classes - -* [Balance](../classes/_type_balance_.balance.md) -* [BalanceOf](../classes/_type_balance_.balanceof.md) - ---- - diff --git a/docs/types/modules/_type_bft_.html b/docs/types/modules/_type_bft_.html deleted file mode 100644 index b83f02c09e..0000000000 --- a/docs/types/modules/_type_bft_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_bft_.md b/docs/types/modules/_type_bft_.md deleted file mode 100644 index f322b3f6e5..0000000000 --- a/docs/types/modules/_type_bft_.md +++ /dev/null @@ -1,37 +0,0 @@ - - -# Index - -### Classes - -* [BftAuthoritySignature](../classes/_type_bft_.bftauthoritysignature.md) -* [BftHashSignature](../classes/_type_bft_.bfthashsignature.md) - -### Type aliases - -* [BftAuthoritySignatureValue](_type_bft_.md#bftauthoritysignaturevalue) -* [BftHashSignatureValue](_type_bft_.md#bfthashsignaturevalue) - ---- - -# Type aliases - - - -## BftAuthoritySignatureValue - -**Ƭ BftAuthoritySignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* - -*Defined in [type/Bft.ts:12](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L12)* - -___ - - -## BftHashSignatureValue - -**Ƭ BftHashSignatureValue**: *[[AnyU8a](_types_.md#anyu8a), [AnyU8a](_types_.md#anyu8a)]* - -*Defined in [type/Bft.ts:43](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Bft.ts#L43)* - -___ - diff --git a/docs/types/modules/_type_block_.html b/docs/types/modules/_type_block_.html deleted file mode 100644 index acc8d50245..0000000000 --- a/docs/types/modules/_type_block_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_block_.md b/docs/types/modules/_type_block_.md deleted file mode 100644 index 41e6ec52e1..0000000000 --- a/docs/types/modules/_type_block_.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# Index - -### Classes - -* [Block](../classes/_type_block_.block.md) - -### Type aliases - -* [BlockValue](_type_block_.md#blockvalue) - ---- - -# Type aliases - - - -## BlockValue - -**Ƭ BlockValue**: *`object`* - -*Defined in [type/Block.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Block.ts#L14)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_type_blocknumber_.html b/docs/types/modules/_type_blocknumber_.html deleted file mode 100644 index a40bcd3fca..0000000000 --- a/docs/types/modules/_type_blocknumber_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_blocknumber_.md b/docs/types/modules/_type_blocknumber_.md deleted file mode 100644 index 84ab7ba2d5..0000000000 --- a/docs/types/modules/_type_blocknumber_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [BlockNumber](../classes/_type_blocknumber_.blocknumber.md) - ---- - diff --git a/docs/types/modules/_type_codehash_.html b/docs/types/modules/_type_codehash_.html deleted file mode 100644 index 8d6ca015b4..0000000000 --- a/docs/types/modules/_type_codehash_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_codehash_.md b/docs/types/modules/_type_codehash_.md deleted file mode 100644 index 5042c05cef..0000000000 --- a/docs/types/modules/_type_codehash_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [CodeHash](../classes/_type_codehash_.codehash.md) - ---- - diff --git a/docs/types/modules/_type_digest_.html b/docs/types/modules/_type_digest_.html deleted file mode 100644 index 92ec66d0b3..0000000000 --- a/docs/types/modules/_type_digest_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_digest_.md b/docs/types/modules/_type_digest_.md deleted file mode 100644 index ad6b513e40..0000000000 --- a/docs/types/modules/_type_digest_.md +++ /dev/null @@ -1,15 +0,0 @@ - - -# Index - -### Classes - -* [AuthoritiesChange](../classes/_type_digest_.authoritieschange.md) -* [ChangesTrieRoot](../classes/_type_digest_.changestrieroot.md) -* [Digest](../classes/_type_digest_.digest.md) -* [DigestItem](../classes/_type_digest_.digestitem.md) -* [Other](../classes/_type_digest_.other.md) -* [Seal](../classes/_type_digest_.seal.md) - ---- - diff --git a/docs/types/modules/_type_event_.html b/docs/types/modules/_type_event_.html deleted file mode 100644 index 433904a051..0000000000 --- a/docs/types/modules/_type_event_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_event_.md b/docs/types/modules/_type_event_.md deleted file mode 100644 index 8284bb6297..0000000000 --- a/docs/types/modules/_type_event_.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Index - -### Classes - -* [Event](../classes/_type_event_.event.md) -* [EventData](../classes/_type_event_.eventdata.md) -* [EventIndex](../classes/_type_event_.eventindex.md) - ---- - diff --git a/docs/types/modules/_type_eventrecord_.html b/docs/types/modules/_type_eventrecord_.html deleted file mode 100644 index 5da4fa7aac..0000000000 --- a/docs/types/modules/_type_eventrecord_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_eventrecord_.md b/docs/types/modules/_type_eventrecord_.md deleted file mode 100644 index 1b1fc3bf63..0000000000 --- a/docs/types/modules/_type_eventrecord_.md +++ /dev/null @@ -1,13 +0,0 @@ - - -# Index - -### Classes - -* [ApplyExtrinsic](../classes/_type_eventrecord_.applyextrinsic.md) -* [EventRecord](../classes/_type_eventrecord_.eventrecord.md) -* [Finalization](../classes/_type_eventrecord_.finalization.md) -* [Phase](../classes/_type_eventrecord_.phase.md) - ---- - diff --git a/docs/types/modules/_type_extrinsic_.html b/docs/types/modules/_type_extrinsic_.html deleted file mode 100644 index 33ec286a4d..0000000000 --- a/docs/types/modules/_type_extrinsic_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_extrinsic_.md b/docs/types/modules/_type_extrinsic_.md deleted file mode 100644 index 0ea454ae18..0000000000 --- a/docs/types/modules/_type_extrinsic_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Extrinsic](../classes/_type_extrinsic_.extrinsic.md) - ---- - diff --git a/docs/types/modules/_type_extrinsicera_.html b/docs/types/modules/_type_extrinsicera_.html deleted file mode 100644 index 5e76ee6d00..0000000000 --- a/docs/types/modules/_type_extrinsicera_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_extrinsicera_.md b/docs/types/modules/_type_extrinsicera_.md deleted file mode 100644 index 8101decebf..0000000000 --- a/docs/types/modules/_type_extrinsicera_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ExtrinsicEra](../classes/_type_extrinsicera_.extrinsicera.md) - ---- - diff --git a/docs/types/modules/_type_extrinsics_.html b/docs/types/modules/_type_extrinsics_.html deleted file mode 100644 index 03d22d95a9..0000000000 --- a/docs/types/modules/_type_extrinsics_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_extrinsics_.md b/docs/types/modules/_type_extrinsics_.md deleted file mode 100644 index 936c08f8cb..0000000000 --- a/docs/types/modules/_type_extrinsics_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Extrinsics](../classes/_type_extrinsics_.extrinsics.md) - ---- - diff --git a/docs/types/modules/_type_extrinsicsignature_.html b/docs/types/modules/_type_extrinsicsignature_.html deleted file mode 100644 index 64d4ae7341..0000000000 --- a/docs/types/modules/_type_extrinsicsignature_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_extrinsicsignature_.md b/docs/types/modules/_type_extrinsicsignature_.md deleted file mode 100644 index 4d0c0333a0..0000000000 --- a/docs/types/modules/_type_extrinsicsignature_.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# Index - -### Classes - -* [ExtrinsicSignature](../classes/_type_extrinsicsignature_.extrinsicsignature.md) - -### Variables - -* [IMMORTAL_ERA](_type_extrinsicsignature_.md#immortal_era) - ---- - -# Variables - - - -## `` IMMORTAL_ERA - -**● IMMORTAL_ERA**: *`Uint8Array`* = new Uint8Array([0]) - -*Defined in [type/ExtrinsicSignature.ts:18](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/ExtrinsicSignature.ts#L18)* - -___ - diff --git a/docs/types/modules/_type_gas_.html b/docs/types/modules/_type_gas_.html deleted file mode 100644 index 409bccac57..0000000000 --- a/docs/types/modules/_type_gas_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_gas_.md b/docs/types/modules/_type_gas_.md deleted file mode 100644 index 6fa45c4183..0000000000 --- a/docs/types/modules/_type_gas_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Gas](../classes/_type_gas_.gas.md) - ---- - diff --git a/docs/types/modules/_type_hash_.html b/docs/types/modules/_type_hash_.html deleted file mode 100644 index 72ffdfaeb6..0000000000 --- a/docs/types/modules/_type_hash_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_hash_.md b/docs/types/modules/_type_hash_.md deleted file mode 100644 index 0d4d3698b1..0000000000 --- a/docs/types/modules/_type_hash_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Hash](../classes/_type_hash_.hash.md) - ---- - diff --git a/docs/types/modules/_type_header_.html b/docs/types/modules/_type_header_.html deleted file mode 100644 index 2dbf1310aa..0000000000 --- a/docs/types/modules/_type_header_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_header_.md b/docs/types/modules/_type_header_.md deleted file mode 100644 index 195a98f263..0000000000 --- a/docs/types/modules/_type_header_.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# Index - -### Classes - -* [Header](../classes/_type_header_.header.md) -* [HeaderExtended](../classes/_type_header_.headerextended.md) - -### Type aliases - -* [HeaderValue](_type_header_.md#headervalue) - ---- - -# Type aliases - - - -## HeaderValue - -**Ƭ HeaderValue**: *`object`* - -*Defined in [type/Header.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Header.ts#L17)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_type_inherentofflinereport_.html b/docs/types/modules/_type_inherentofflinereport_.html deleted file mode 100644 index 3f5062e02a..0000000000 --- a/docs/types/modules/_type_inherentofflinereport_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_inherentofflinereport_.md b/docs/types/modules/_type_inherentofflinereport_.md deleted file mode 100644 index 3796d619e8..0000000000 --- a/docs/types/modules/_type_inherentofflinereport_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [InherentOfflineReport](../classes/_type_inherentofflinereport_.inherentofflinereport.md) - ---- - diff --git a/docs/types/modules/_type_justification_.html b/docs/types/modules/_type_justification_.html deleted file mode 100644 index f1dbe27928..0000000000 --- a/docs/types/modules/_type_justification_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_justification_.md b/docs/types/modules/_type_justification_.md deleted file mode 100644 index fc5b284f1a..0000000000 --- a/docs/types/modules/_type_justification_.md +++ /dev/null @@ -1,29 +0,0 @@ - - -# Index - -### Classes - -* [Justification](../classes/_type_justification_.justification.md) -* [RhdJustification](../classes/_type_justification_.rhdjustification.md) - -### Type aliases - -* [RhdJustificationValue](_type_justification_.md#rhdjustificationvalue) - ---- - -# Type aliases - - - -## RhdJustificationValue - -**Ƭ RhdJustificationValue**: *`object`* - -*Defined in [type/Justification.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/Justification.ts#L14)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_type_keyvalue_.html b/docs/types/modules/_type_keyvalue_.html deleted file mode 100644 index 5544362615..0000000000 --- a/docs/types/modules/_type_keyvalue_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_keyvalue_.md b/docs/types/modules/_type_keyvalue_.md deleted file mode 100644 index 805b3264d5..0000000000 --- a/docs/types/modules/_type_keyvalue_.md +++ /dev/null @@ -1,27 +0,0 @@ - - -# Index - -### Classes - -* [KeyValue](../classes/_type_keyvalue_.keyvalue.md) -* [KeyValueOption](../classes/_type_keyvalue_.keyvalueoption.md) - -### Type aliases - -* [KeyValueOptionValue](_type_keyvalue_.md#keyvalueoptionvalue) - ---- - -# Type aliases - - - -## KeyValueOptionValue - -**Ƭ KeyValueOptionValue**: *[[AnyU8a](_types_.md#anyu8a), `undefined` \| `string` \| `Uint8Array` \| `number`[]]* - -*Defined in [type/KeyValue.ts:49](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/KeyValue.ts#L49)* - -___ - diff --git a/docs/types/modules/_type_lockperiods_.html b/docs/types/modules/_type_lockperiods_.html deleted file mode 100644 index 93c768308b..0000000000 --- a/docs/types/modules/_type_lockperiods_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_lockperiods_.md b/docs/types/modules/_type_lockperiods_.md deleted file mode 100644 index 1535678764..0000000000 --- a/docs/types/modules/_type_lockperiods_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [LocKPeriods](../classes/_type_lockperiods_.lockperiods.md) - ---- - diff --git a/docs/types/modules/_type_misbehaviorreport_.html b/docs/types/modules/_type_misbehaviorreport_.html deleted file mode 100644 index 112faa544c..0000000000 --- a/docs/types/modules/_type_misbehaviorreport_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_misbehaviorreport_.md b/docs/types/modules/_type_misbehaviorreport_.md deleted file mode 100644 index 71a49fca9c..0000000000 --- a/docs/types/modules/_type_misbehaviorreport_.md +++ /dev/null @@ -1,16 +0,0 @@ - - -# Index - -### Classes - -* [BftAtReport](../classes/_type_misbehaviorreport_.bftatreport.md) -* [BftDoubleCommit](../classes/_type_misbehaviorreport_.bftdoublecommit.md) -* [BftDoublePrepare](../classes/_type_misbehaviorreport_.bftdoubleprepare.md) -* [BftDoublePropose](../classes/_type_misbehaviorreport_.bftdoublepropose.md) -* [BftProposeOutOfTurn](../classes/_type_misbehaviorreport_.bftproposeoutofturn.md) -* [MisbehaviorKind](../classes/_type_misbehaviorreport_.misbehaviorkind.md) -* [MisbehaviorReport](../classes/_type_misbehaviorreport_.misbehaviorreport.md) - ---- - diff --git a/docs/types/modules/_type_newaccountoutcome_.html b/docs/types/modules/_type_newaccountoutcome_.html deleted file mode 100644 index 7530766e67..0000000000 --- a/docs/types/modules/_type_newaccountoutcome_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_newaccountoutcome_.md b/docs/types/modules/_type_newaccountoutcome_.md deleted file mode 100644 index 3704365105..0000000000 --- a/docs/types/modules/_type_newaccountoutcome_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [NewAccountOutcome](../classes/_type_newaccountoutcome_.newaccountoutcome.md) - ---- - diff --git a/docs/types/modules/_type_nonce_.html b/docs/types/modules/_type_nonce_.html deleted file mode 100644 index 0c86e5f357..0000000000 --- a/docs/types/modules/_type_nonce_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_nonce_.md b/docs/types/modules/_type_nonce_.md deleted file mode 100644 index cfd535bf1d..0000000000 --- a/docs/types/modules/_type_nonce_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Nonce](../classes/_type_nonce_.nonce.md) - ---- - diff --git a/docs/types/modules/_type_noncecompact_.html b/docs/types/modules/_type_noncecompact_.html deleted file mode 100644 index b2cb22f733..0000000000 --- a/docs/types/modules/_type_noncecompact_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_noncecompact_.md b/docs/types/modules/_type_noncecompact_.md deleted file mode 100644 index 1628296a52..0000000000 --- a/docs/types/modules/_type_noncecompact_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [NonceCompact](../classes/_type_noncecompact_.noncecompact.md) - ---- - diff --git a/docs/types/modules/_type_origin_.html b/docs/types/modules/_type_origin_.html deleted file mode 100644 index 92aec1d40e..0000000000 --- a/docs/types/modules/_type_origin_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_origin_.md b/docs/types/modules/_type_origin_.md deleted file mode 100644 index e21fb0f42e..0000000000 --- a/docs/types/modules/_type_origin_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Origin](../classes/_type_origin_.origin.md) - ---- - diff --git a/docs/types/modules/_type_paraid_.html b/docs/types/modules/_type_paraid_.html deleted file mode 100644 index 60a35f9770..0000000000 --- a/docs/types/modules/_type_paraid_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_paraid_.md b/docs/types/modules/_type_paraid_.md deleted file mode 100644 index 6860afe030..0000000000 --- a/docs/types/modules/_type_paraid_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ParaId](../classes/_type_paraid_.paraid.md) - ---- - diff --git a/docs/types/modules/_type_perbill_.html b/docs/types/modules/_type_perbill_.html deleted file mode 100644 index 8de0db3891..0000000000 --- a/docs/types/modules/_type_perbill_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_perbill_.md b/docs/types/modules/_type_perbill_.md deleted file mode 100644 index 3b3a7a5dbb..0000000000 --- a/docs/types/modules/_type_perbill_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Perbill](../classes/_type_perbill_.perbill.md) - ---- - diff --git a/docs/types/modules/_type_permill_.html b/docs/types/modules/_type_permill_.html deleted file mode 100644 index 2ca9c1aea3..0000000000 --- a/docs/types/modules/_type_permill_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_permill_.md b/docs/types/modules/_type_permill_.md deleted file mode 100644 index 2f582d0292..0000000000 --- a/docs/types/modules/_type_permill_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Permill](../classes/_type_permill_.permill.md) - ---- - diff --git a/docs/types/modules/_type_prefabwasmmodule_.html b/docs/types/modules/_type_prefabwasmmodule_.html deleted file mode 100644 index 013d91e5c0..0000000000 --- a/docs/types/modules/_type_prefabwasmmodule_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_prefabwasmmodule_.md b/docs/types/modules/_type_prefabwasmmodule_.md deleted file mode 100644 index eaaae0f03c..0000000000 --- a/docs/types/modules/_type_prefabwasmmodule_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [PrefabWasmModule](../classes/_type_prefabwasmmodule_.prefabwasmmodule.md) - ---- - diff --git a/docs/types/modules/_type_propindex_.html b/docs/types/modules/_type_propindex_.html deleted file mode 100644 index 7972ca249e..0000000000 --- a/docs/types/modules/_type_propindex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_propindex_.md b/docs/types/modules/_type_propindex_.md deleted file mode 100644 index b7af6988a0..0000000000 --- a/docs/types/modules/_type_propindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [PropIndex](../classes/_type_propindex_.propindex.md) - ---- - diff --git a/docs/types/modules/_type_proposal_.html b/docs/types/modules/_type_proposal_.html deleted file mode 100644 index be979bde2a..0000000000 --- a/docs/types/modules/_type_proposal_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_proposal_.md b/docs/types/modules/_type_proposal_.md deleted file mode 100644 index f52667d0eb..0000000000 --- a/docs/types/modules/_type_proposal_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Proposal](../classes/_type_proposal_.proposal.md) - ---- - diff --git a/docs/types/modules/_type_proposalindex_.html b/docs/types/modules/_type_proposalindex_.html deleted file mode 100644 index d1505b3882..0000000000 --- a/docs/types/modules/_type_proposalindex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_proposalindex_.md b/docs/types/modules/_type_proposalindex_.md deleted file mode 100644 index 9bd83debfc..0000000000 --- a/docs/types/modules/_type_proposalindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ProposalIndex](../classes/_type_proposalindex_.proposalindex.md) - ---- - diff --git a/docs/types/modules/_type_referendumindex_.html b/docs/types/modules/_type_referendumindex_.html deleted file mode 100644 index 596486cfc4..0000000000 --- a/docs/types/modules/_type_referendumindex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_referendumindex_.md b/docs/types/modules/_type_referendumindex_.md deleted file mode 100644 index d04db4e7a0..0000000000 --- a/docs/types/modules/_type_referendumindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ReferendumIndex](../classes/_type_referendumindex_.referendumindex.md) - ---- - diff --git a/docs/types/modules/_type_referenduminfo_.html b/docs/types/modules/_type_referenduminfo_.html deleted file mode 100644 index 653e7f55fb..0000000000 --- a/docs/types/modules/_type_referenduminfo_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_referenduminfo_.md b/docs/types/modules/_type_referenduminfo_.md deleted file mode 100644 index bc2147e017..0000000000 --- a/docs/types/modules/_type_referenduminfo_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ReferendumInfo](../classes/_type_referenduminfo_.referenduminfo.md) - ---- - diff --git a/docs/types/modules/_type_schedule_.html b/docs/types/modules/_type_schedule_.html deleted file mode 100644 index faef0ac8d6..0000000000 --- a/docs/types/modules/_type_schedule_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_schedule_.md b/docs/types/modules/_type_schedule_.md deleted file mode 100644 index 887d6d8e79..0000000000 --- a/docs/types/modules/_type_schedule_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Schedule](../classes/_type_schedule_.schedule.md) - ---- - diff --git a/docs/types/modules/_type_seedof_.html b/docs/types/modules/_type_seedof_.html deleted file mode 100644 index d3e4b3f9dd..0000000000 --- a/docs/types/modules/_type_seedof_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_seedof_.md b/docs/types/modules/_type_seedof_.md deleted file mode 100644 index 982989ea3f..0000000000 --- a/docs/types/modules/_type_seedof_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [SeedOf](../classes/_type_seedof_.seedof.md) - ---- - diff --git a/docs/types/modules/_type_sessionkey_.html b/docs/types/modules/_type_sessionkey_.html deleted file mode 100644 index 62ddb91bb6..0000000000 --- a/docs/types/modules/_type_sessionkey_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_sessionkey_.md b/docs/types/modules/_type_sessionkey_.md deleted file mode 100644 index 993cd3fd08..0000000000 --- a/docs/types/modules/_type_sessionkey_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [SessionKey](../classes/_type_sessionkey_.sessionkey.md) - ---- - diff --git a/docs/types/modules/_type_signature_.html b/docs/types/modules/_type_signature_.html deleted file mode 100644 index 71dadf34e4..0000000000 --- a/docs/types/modules/_type_signature_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_signature_.md b/docs/types/modules/_type_signature_.md deleted file mode 100644 index f3d42f9c12..0000000000 --- a/docs/types/modules/_type_signature_.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# Index - -### Classes - -* [Ed25519Signature](../classes/_type_signature_.ed25519signature.md) -* [Signature](../classes/_type_signature_.signature.md) -* [Sr25519Signature](../classes/_type_signature_.sr25519signature.md) - ---- - diff --git a/docs/types/modules/_type_signaturepayload_.html b/docs/types/modules/_type_signaturepayload_.html deleted file mode 100644 index 3313b01722..0000000000 --- a/docs/types/modules/_type_signaturepayload_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_signaturepayload_.md b/docs/types/modules/_type_signaturepayload_.md deleted file mode 100644 index 4d6e7f73de..0000000000 --- a/docs/types/modules/_type_signaturepayload_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [SignaturePayload](../classes/_type_signaturepayload_.signaturepayload.md) - ---- - diff --git a/docs/types/modules/_type_storedpendingchange_.html b/docs/types/modules/_type_storedpendingchange_.html deleted file mode 100644 index 78719c1cf7..0000000000 --- a/docs/types/modules/_type_storedpendingchange_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_storedpendingchange_.md b/docs/types/modules/_type_storedpendingchange_.md deleted file mode 100644 index 96c8eb34bf..0000000000 --- a/docs/types/modules/_type_storedpendingchange_.md +++ /dev/null @@ -1,41 +0,0 @@ - - -# Index - -### Classes - -* [NextAuthority](../classes/_type_storedpendingchange_.nextauthority.md) -* [StoredPendingChange](../classes/_type_storedpendingchange_.storedpendingchange.md) - -### Type aliases - -* [NextAuthorityValue](_type_storedpendingchange_.md#nextauthorityvalue) -* [StoredPendingChangeValue](_type_storedpendingchange_.md#storedpendingchangevalue) - ---- - -# Type aliases - - - -## NextAuthorityValue - -**Ƭ NextAuthorityValue**: *`object`* - -*Defined in [type/StoredPendingChange.ts:14](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L14)* - -#### Type declaration - -___ - - -## StoredPendingChangeValue - -**Ƭ StoredPendingChangeValue**: *`object`* - -*Defined in [type/StoredPendingChange.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/type/StoredPendingChange.ts#L19)* - -#### Type declaration - -___ - diff --git a/docs/types/modules/_type_validatorprefs_.html b/docs/types/modules/_type_validatorprefs_.html deleted file mode 100644 index ffd1b936de..0000000000 --- a/docs/types/modules/_type_validatorprefs_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_validatorprefs_.md b/docs/types/modules/_type_validatorprefs_.md deleted file mode 100644 index 8429da53dd..0000000000 --- a/docs/types/modules/_type_validatorprefs_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [ValidatorPrefs](../classes/_type_validatorprefs_.validatorprefs.md) - ---- - diff --git a/docs/types/modules/_type_vestingschedule_.html b/docs/types/modules/_type_vestingschedule_.html deleted file mode 100644 index 9ec6dcbe23..0000000000 --- a/docs/types/modules/_type_vestingschedule_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_vestingschedule_.md b/docs/types/modules/_type_vestingschedule_.md deleted file mode 100644 index 70d51dd65f..0000000000 --- a/docs/types/modules/_type_vestingschedule_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [VestingSchedule](../classes/_type_vestingschedule_.vestingschedule.md) - ---- - diff --git a/docs/types/modules/_type_vote_.html b/docs/types/modules/_type_vote_.html deleted file mode 100644 index 97ca232efc..0000000000 --- a/docs/types/modules/_type_vote_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_vote_.md b/docs/types/modules/_type_vote_.md deleted file mode 100644 index cd79a85cf9..0000000000 --- a/docs/types/modules/_type_vote_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [Vote](../classes/_type_vote_.vote.md) - ---- - diff --git a/docs/types/modules/_type_voteindex_.html b/docs/types/modules/_type_voteindex_.html deleted file mode 100644 index 6a536c2723..0000000000 --- a/docs/types/modules/_type_voteindex_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_voteindex_.md b/docs/types/modules/_type_voteindex_.md deleted file mode 100644 index ce5b2323e5..0000000000 --- a/docs/types/modules/_type_voteindex_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [VoteIndex](../classes/_type_voteindex_.voteindex.md) - ---- - diff --git a/docs/types/modules/_type_votethreshold_.html b/docs/types/modules/_type_votethreshold_.html deleted file mode 100644 index 0056a68b6c..0000000000 --- a/docs/types/modules/_type_votethreshold_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - - - - - diff --git a/docs/types/modules/_type_votethreshold_.md b/docs/types/modules/_type_votethreshold_.md deleted file mode 100644 index 144d0c4588..0000000000 --- a/docs/types/modules/_type_votethreshold_.md +++ /dev/null @@ -1,10 +0,0 @@ - - -# Index - -### Classes - -* [VoteThreshold](../classes/_type_votethreshold_.votethreshold.md) - ---- - diff --git a/docs/types/modules/_types_.html b/docs/types/modules/_types_.html deleted file mode 100644 index c491a640f4..0000000000 --- a/docs/types/modules/_types_.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - Index | polkadot-js/api - - - - - - - -
polkadot-js/api

Index

Interfaces

Type aliases

Type aliases

AnyNumber

Ƭ AnyNumber: BN | Uint8Array | number | string

Defined in types.ts:17

AnyString

Ƭ AnyString: string | String

Defined in types.ts:19

AnyU8a

Ƭ AnyU8a: Uint8Array | Array<number> | string

Defined in types.ts:21

CodecArg

Ƭ CodecArg: Codec | BN | Boolean | String | Uint8Array | boolean | number | string | undefined | CodecArgArray | CodecArgObject

Defined in types.ts:7

CodecCallback

Ƭ CodecCallback: function

Defined in types.ts:9

Type declaration

▸(result: T): any

Parameters:

Name Type
result T

Returns: any

CodecTo

Ƭ CodecTo: "toHex" | "toJSON" | "toString" | "toU8a"

Defined in types.ts:68

ConstructorDef

Ƭ ConstructorDef: object

Defined in types.ts:74

Type declaration

RegistryTypes

Ƭ RegistryTypes: object

Defined in types.ts:78

Type declaration

[name: string]: Constructor | string | object

SignatureOptions

Ƭ SignatureOptions: object

Defined in types.ts:91

Type declaration

TypeDef

Ƭ TypeDef: object

Defined in types.ts:76

Type declaration

- - - diff --git a/docs/types/modules/_types_.md b/docs/types/modules/_types_.md deleted file mode 100644 index f45a2a37d7..0000000000 --- a/docs/types/modules/_types_.md +++ /dev/null @@ -1,143 +0,0 @@ - - -# Index - -### Interfaces - -* [Codec](../interfaces/_types_.codec.md) -* [Constructor](../interfaces/_types_.constructor.md) -* [RuntimeVersionInterface](../interfaces/_types_.runtimeversioninterface.md) - -### Type aliases - -* [AnyNumber](_types_.md#anynumber) -* [AnyString](_types_.md#anystring) -* [AnyU8a](_types_.md#anyu8a) -* [CodecArg](_types_.md#codecarg) -* [CodecCallback](_types_.md#codeccallback) -* [CodecTo](_types_.md#codecto) -* [ConstructorDef](_types_.md#constructordef) -* [RegistryTypes](_types_.md#registrytypes) -* [SignatureOptions](_types_.md#signatureoptions) -* [TypeDef](_types_.md#typedef) - ---- - -# Type aliases - - - -## AnyNumber - -**Ƭ AnyNumber**: *`BN` \| `Uint8Array` \| `number` \| `string`* - -*Defined in [types.ts:17](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L17)* - -___ - - -## AnyString - -**Ƭ AnyString**: *`string` \| `String`* - -*Defined in [types.ts:19](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L19)* - -___ - - -## AnyU8a - -**Ƭ AnyU8a**: *`Uint8Array` \| `Array`<`number`> \| `string`* - -*Defined in [types.ts:21](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L21)* - -___ - - -## CodecArg - -**Ƭ CodecArg**: *[Codec](../interfaces/_types_.codec.md) \| `BN` \| `Boolean` \| `String` \| `Uint8Array` \| `boolean` \| `number` \| `string` \| `undefined` \| `CodecArgArray` \| `CodecArgObject`* - -*Defined in [types.ts:7](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L7)* - -___ - - -## CodecCallback - -**Ƭ CodecCallback**: *`function`* - -*Defined in [types.ts:9](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L9)* - -#### Type declaration -▸(result: *`T`*): `any` - -**Parameters:** - -| Name | Type | -| ------ | ------ | -| result | `T` | - -**Returns:** `any` - -___ - - -## CodecTo - -**Ƭ CodecTo**: *"toHex" \| "toJSON" \| "toString" \| "toU8a"* - -*Defined in [types.ts:68](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L68)* - -___ - - -## ConstructorDef - -**Ƭ ConstructorDef**: *`object`* - -*Defined in [types.ts:74](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L74)* - -#### Type declaration - -[index: `string`]: [Constructor](../interfaces/_types_.constructor.md)<`T`> - -___ - - -## RegistryTypes - -**Ƭ RegistryTypes**: *`object`* - -*Defined in [types.ts:78](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L78)* - -#### Type declaration - -[name: `string`]: [Constructor](../interfaces/_types_.constructor.md) \| `string` \| `object` - -___ - - -## SignatureOptions - -**Ƭ SignatureOptions**: *`object`* - -*Defined in [types.ts:91](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L91)* - -#### Type declaration - -___ - - -## TypeDef - -**Ƭ TypeDef**: *`object`* - -*Defined in [types.ts:76](https://github.com/polkadot-js/api/blob/1ea1f6f/packages/types/src/types.ts#L76)* - -#### Type declaration - -[index: `string`]: [Codec](../interfaces/_types_.codec.md) - -___ -